docs: generate a Mintlify SDK reference artifact from TypeDoc

[gyaneshgouraw]

Description

Adds groundwork for publishing the @auth0/auth0-react API reference to Mintlify/docs-v2. No library code changes.

• Documents only public exports.
• Groups API exports into useful categories.
• Improves the TypeDoc sidebar/navigation.
• Adds npm run docs:docsv2 to generate the Mintlify artifact and navigation.
• Adds Mintlify-specific type links.

Important

Generated docs/ and mintlify/ outputs are not committed. Publishing to docs-v2 is still manual.

Diagram

%%{init: { 'theme': 'base', 'themeVariables': { 'primaryColor': '#eef6f7', 'primaryTextColor': '#2f3a3d', 'primaryBorderColor': '#b8d8dd', 'lineColor': '#7f9ea6', 'background': '#ffffff' } } }%%
flowchart LR
  subgraph Config["Config"]
    Base["typedoc.js"]
    V2["typedoc.docsv2.js"]
  end
  subgraph Transform["TypeDoc run"]
    Cat["scripts/typedoc-plugin.js<br/>categories + auth0 theme"]
    Mint["scripts/typedoc-plugin-mintlify.js<br/>markdown type links"]
    Nav["scripts/build-mintlify-nav.mjs"]
  end
  subgraph Out["Output"]
    Html[("docs/ HTML site")]
    Json[("mintlify/.../auth0-react.json")]
    NavJson[("mintlify/.../react-reference.en.json")]
  end
  Base --> Cat --> Html
  Base -. "spread, minus out/theme" .-> V2
  V2 --> Cat
  V2 --> Mint --> Json --> Nav --> NavJson
  style Config fill:#f3f3f3,stroke:#cfcfcf
  style Transform fill:#eff7ec,stroke:#b9d9ad
  style Out fill:#eef2fa,stroke:#b8c7e6

Loading

Testing

Run:

npm run docs
npm run docs:docsv2

Verify the HTML docs, generated Mintlify artifact, and navigation.

Checklist

• Documentation updated
• GitHub checks passing
• Correct base branch

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: ffbd723c-88d7-45d6-9181-cb238575b71a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

---

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.}

[gyaneshgouraw]

Closing this PR as newer PR is up adding this changes with enhancements - #1258