Update from code changes: document SDK reference setup#6713
Closed
mintlify[bot] wants to merge 2 commits into
Closed
Update from code changes: document SDK reference setup#6713mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Collaborator
|
superseded by #6717 |
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
2 participants
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
Documents the new
sdknavigation property indocs.json, which generates SDK reference pages from TypeDoc, DocFX, Javadoc, Sphinx, and phpDocumentor artifacts at build time.Changes
api-playground/sdk-setup.mdxcovering supported formats, configuration fields (format,source,directory), local and remote sources, generated page structure, and how to exclude raw artifacts via.mintignore.docs.json.Context
Upstream: https://github.com/mintlify/mint/pull/9449
Note
Low Risk
Documentation and navigation-only changes with no runtime or product code impact.
Overview
Adds SDK reference setup documentation for the
sdktab property indocs.json, which turns TypeDoc, DocFX, Javadoc, Sphinx, and phpDocumentor build artifacts into grouped MDX reference pages at build time.The new
api-playground/sdk-setuppage covers supported formats,format/source/directoryconfiguration (local paths, HTTPS URLs, optional output directory), tab constraints (no mixing withopenapi/asyncapi/graphqlorpages),.mintignorefor raw artifacts, remote fetch limits and safety, and what gets generated (groups, per-symbol pages, cross-links). The same guide is added in Spanish, French, and Chinese, with locale-prefixed internal links; localized MDX uses explicit headingdivids for anchor stability.Document APIs navigation in
docs.jsonandes.json,fr.json, andzh.jsonnow listssdk-setupbefore troubleshooting.Reviewed by Cursor Bugbot for commit 9116223. Bugbot is set up for automated code reviews on this repo. Configure here.