feat(docs): add foundation for automating SDK reference docs

[mikemimik]

• Refactor typedoc.js to use entryPoints resolve strategy and auth0 theme
• Add scripts/typedoc-plugin.js: categorizes exports and extends sidebar nav
• Add scripts/typedoc-plugin-mintlify.js: injects markdown type links for Mintlify
• Add typedoc.docsv2.js: JSON-only config for docs-v2 Mintlify pipeline
• Add docs:docsv2 npm script for generating the Mintlify artifact

By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

Describe the purpose of this PR along with any background information and the impacts of the proposed change. For the benefit of the community, please do not assume prior context.

Provide details that support your chosen implementation, including: breaking changes, alternatives considered, changes to the API, etc.

If the UI is being changed, please provide screenshots.

References

Include any links supporting this change such as a:

• GitHub Issue/PR number addressed or fixed
• Auth0 Community post
• StackOverflow post
• Support forum thread
• Related pull requests/issues from other repos

If there are no references, simply delete this section.

Testing

Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.

Also include details of the environment this PR was developed in (language/platform/browser version).

• This change adds test coverage for new/changed/fixed functionality

Checklist

• I have added documentation for new/changed functionality in this PR or in auth0.com/docs
• All active GitHub checks for tests, formatting, and security are passing
• The correct base branch is being used, if not the default branch

Summary by CodeRabbit

• Documentation
  • Improved the Auth0 React SDK API reference with clearer categories, task-oriented navigation, and expanded sidebar organization.
  • Added cross-links between related types and API symbols in Mintlify documentation.
  • Added structured documentation output to support more consistent, readable API reference updates.
  • Improved documentation filtering to focus on relevant public APIs while excluding internal and test-only details.
  • Updated documentation generation to provide more useful search results from comments.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: c789117a-8faf-4f4d-a506-05c9f004f886

📥 Commits

Reviewing files that changed from the base of the PR and between 4a053a7 and 1cd8dc3.

📒 Files selected for processing (5)

• package.json
• scripts/typedoc-plugin-mintlify.js
• scripts/typedoc-plugin.js
• typedoc.docsv2.js
• typedoc.js

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

---

📝 Walkthrough

Walkthrough

The pull request expands TypeDoc configuration and navigation, adds Mintlify JSON link generation, updates documentation scripts, and changes React runtime and type package versions.

Changes

TypeDoc documentation generation

Layer / File(s)	Summary
TypeDoc navigation and categorization scripts/typedoc-plugin.js, typedoc.js	The TypeDoc plugin categorizes SDK exports and Auth0ContextInterface members. The configuration adds custom navigation, filtering, sorting, entry-point resolution, and sidebar settings.
Mintlify JSON documentation output scripts/typedoc-plugin-mintlify.js, typedoc.docsv2.js	The Mintlify plugin collects referenced TypeDoc types and appends links to generated pages. The second configuration writes formatted JSON documentation using the Mintlify directory setting.

Package and script updates

Layer / File(s)	Summary
Documentation scripts and React package versions package.json	Documentation scripts use both TypeDoc option files. React, React DOM, and their type packages use the updated versions.

Priority: ⬇️ Low

Estimated code review effort: 4 (Complex) | ~45 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant TypeDoc
  participant typedoc.js
  participant typedoc-plugin-mintlify.js
  participant JSONArtifact
  TypeDoc->>typedoc.js: Load documentation options
  TypeDoc->>typedoc-plugin-mintlify.js: Resolve documented reflections
  typedoc-plugin-mintlify.js->>JSONArtifact: Append Mintlify markdown links
  TypeDoc->>JSONArtifact: Write formatted JSON output

Loading

Suggested reviewers: frederikprijck

Merge Risk: ⚪ Minimal · up to 1cd8d

No concrete current-head issue remains that should prevent merging.

🚥 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 clearly and concisely describes the main change: adding the foundation for automated SDK reference documentation, including TypeDoc plugins and Mintlify configuration.
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 8 functions across 4 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 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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