docs: add Mintlify SDK reference generation - #1715
Draft
gyaneshgouraw wants to merge 4 commits into
Draft
Conversation
- Refactor RefreshTokenMode documentation to enhance clarity and update the title to "Auth0 SPA SDK". - Modify package.json to streamline TypeDoc command by removing unnecessary parameters. - Introduce a new TypeDoc plugin to categorize exports and enhance sidebar navigation for better usability. - Add custom CSS for TypeDoc to improve the appearance of the sidebar and prevent clipping of long names. - Update global.ts to correctly categorize ClientConfiguration under "Configuration". - Revise typedoc.js to improve entry point handling, exclude unnecessary files, and customize the documentation output.
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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. Comment |
Keeps this PR to tooling only. The docs/ HTML will be regenerated in a follow-up, since nothing in CI builds it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The local preview only ever served `mint dev` against a hand-written `mintlify/docs.json`, which was never tracked. Nothing it produced was published, so removing it costs nothing: previewing means copying the two generated files into a docs-v2 checkout and running `mint dev` there. Collapses the nav script's two presets into one path, and inlines `typedoc.mintlify.js` into `typedoc.docsv2.js`, whose only distinctive values existed for the preview and were already overridden. Output is unchanged: the nav file is byte-identical and the artifact differs only in the commit SHA baked into source URLs. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds tooling to generate the files required by docs-v2 to publish the
auth0-spa-jsAPI reference using Mintlify.Mintlify supports TypeDoc JSON, but the default output creates a flat reference grouped by TypeScript kind and does not link type names. This PR improves the generated output to make the SDK reference easier to navigate.
Changes
Auth0Clientmembers by task and exposes client methods directly in the sidebar.npm run docs:docsv2to generate:mintlify/docsv2/, matching the docs-v2 directory structure.@categoryannotation insrc/.docs/output is intentionally not regenerated to keep this PR focused on docs-v2 tooling.Testing
Run:
This generates the following files:
mintlify/docsv2/sdk-artifacts/auth0-spa-js.jsonmain/sdk-artifacts/auth0-spa-js.jsonmintlify/docsv2/config/navigation/generated/spa-js-reference.en.jsonmain/config/navigation/generated/spa-js-reference.en.jsonBoth files should be published together because the generated navigation references pages created from the TypeDoc artifact.