chore: build the Mintlify docs artifact as part of npm run docs

[gyaneshgouraw]

Summary

npm run docs now builds both API reference artifacts: the HTML site in docs/ and the Mintlify JSON in mintlify/auth0-react.json. The artifact is committed rather than gitignored.

Motivation

docs-v2 expects each SDK's Mintlify artifact to be present in the SDK repo itself, so it has to be tracked here and refreshed on every release. .shiprc runs npm run docs on postbump, so one command keeps both references in sync per release.

Changes

• docs → docs:html && docs:docsv2, with docs:html as the HTML-only step
• artifact flattened to mintlify/auth0-react.json, kept outside docs/ because typedoc.js cleans that directory on every HTML build
• removed from .gitignore; added to .prettierignore and .semgrepignore alongside the existing docs/ entry

No source or public API changes.

Testing

• npm run docs emits both artifacts
• npm run docs:html alone leaves the JSON byte-identical
• npx prettier --check mintlify/ passes

References

Mirrors auth0/auth0-spa-js#1791.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository: auth0/auth0-react/.coderabbit.yaml
• Review profile: CHILL
• Plan: Advanced
• Run ID: a5435455-d09c-4cc1-be62-bf2434f2f4c6

📥 Commits

Reviewing files that changed from the base of the PR and between 9c6e8e5 and f7aaf1a.

📒 Files selected for processing (7)

• .gitignore
• .prettierignore
• .semgrepignore
• mintlify/auth0-react.json
• package.json
• references/commands.md
• typedoc.docsv2.js

💤 Files with no reviewable changes (1)

• .gitignore

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

---

📝 Walkthrough

Walkthrough

The documentation scripts now generate HTML and Mintlify JSON output through separate commands. The TypeDoc JSON destination and ignore settings have been updated, and the command reference describes the available generation options.

Changes

Mintlify documentation output

Layer / File(s)	Summary
Configure documentation generation and output tracking typedoc.docsv2.js, package.json, references/commands.md, .gitignore, .prettierignore, .semgrepignore	TypeDoc writes JSON to mintlify/auth0-react.json. The docs script runs the HTML and Mintlify JSON commands, which can also run separately. The command reference describes both outputs. Ignore rules are updated for the Mintlify directory.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: yogeshchoudhary147

Merge Risk: ⚪ Minimal · up to f7aaf

The change separates HTML and Mintlify artifact generation as documented. No actionable merge risk is established beyond normal checks.

Architecture Summary

Architecture risk: 🔵 Low · up to f7aaf

The change affects 3 systems.

Changed systems: package.json, references, typedoc.docsv2.js

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — package.json (service) was modified; 1 changed file maps to changed impact.
• observed — references (service) was modified; 1 changed file maps to changed impact.
• observed — typedoc.docsv2.js (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in package.json: docs now runs docs:html followed by docs:docsv2; the previous direct TypeDoc command is moved to the new docs:html script.
• observed — Modified behavior in references/commands.md: The single TypeDoc command and docs/ output description are replaced by commands for HTML-only generation (which cleans docs/ first) and Mintlify JSON-only generation; the comments identify both output directories and say not to edit generated output manually.
• observed — Modified behavior in typedoc.docsv2.js: The JSON output path changes from the docs-v2 staging directory to ./mintlify/auth0-react.json. The comment no longer describes a staging layout or direct-copy publishing; it says the file is committed in both repositories and retains the pretty-printing diff explanation.
• observed — Modified behavior in .gitignore: Removed the ignore rule for mintlify/docsv2/sdk-artifacts/.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: adding the Mintlify documentation artifact build to npm run docs.

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

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