Skip to content

feat(docs): add foundation for automating SDK reference docs - #1761

Open
mikemimik wants to merge 2 commits into
auth0:mainfrom
mikemimik:feat/sdk-reference-docs
Open

mikemimik wants to merge 2 commits into
auth0:mainfrom
mikemimik:feat/sdk-reference-docs

Conversation

@mikemimik

@mikemimik mikemimik commented Sep 15, 2026

Copy link
Copy Markdown

Adds typedoc.docsv2.js and docs:docsv2 script to emit the JSON artifact consumed by the docs-content-pipeline. Includes the typedoc-plugin.js category plugin (required for artifact.categories) and updates typedoc.js to use the new entry-point strategy and filtering.

Changes

References

Testing

  • This change adds unit test coverage
  • This change adds integration test coverage
  • This change has been tested on the latest version of the platform/language

Checklist

Summary by CodeRabbit

  • Documentation
    • Improved API reference navigation with categorized exports and organized client members.
    • Refined filtering so public API documentation focuses on relevant SDK types and members.
    • Added a JSON documentation artifact for the Mintlify-based documentation site.
    • Updated documentation commands to support both the standard API reference and the new documentation format.

Adds typedoc.docsv2.js and docs:docsv2 script to emit the JSON artifact consumed by the docs-content-pipeline. Includes the typedoc-plugin.js category plugin (required for artifact.categories) and updates typedoc.js to use the new entry-point strategy and filtering.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mikemimik
mikemimik requested a review from a team as a code owner September 15, 2026 14:40
@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: auth0/auth0-spa-js/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 65f81eff-47ed-418f-b939-02d8b52b39ad

📥 Commits

Reviewing files that changed from the base of the PR and between f23f4dd and 5095c2a.

📒 Files selected for processing (1)
  • package.json

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The pull request updates TypeDoc to document the public SDK entry point, adds categorized API navigation, and introduces a JSON-only configuration for the docs-v2 artifact. Package scripts support both HTML and docs-v2 documentation builds.

Changes

TypeDoc documentation pipeline

Layer / File(s) Summary
TypeDoc public-surface configuration
typedoc.js
TypeDoc resolves from src/index.ts, filters public members, applies Auth0 categories and navigation settings, and uses the custom theme, plugin, and CSS.
Categorized API navigation
scripts/typedoc-plugin.js
The plugin categorizes exports and Auth0Client members, adds client members to theme navigation, and initializes the Clients accordion state.
HTML and JSON documentation builds
typedoc.docsv2.js, package.json
The docs-v2 configuration emits a pretty-printed JSON artifact without HTML-only options. Package scripts invoke the standard and docs-v2 builds.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Other

Suggested reviewers: frederikprijck

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: it adds the foundation for automated SDK reference documentation through new TypeDoc configuration, categorization, and JSON artifact generation.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 3 files. (1 skipped: 1 …
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants