Document SDK reference generation (typedoc, docfx, javadoc, sphinx, phpdoc)#6717
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
lucaspunz
approved these changes
Jul 24, 2026
This was referenced Jul 24, 2026
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
3 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.
New page
api-playground/sdk-reference-setupdocumenting thesdknavigation property shipped in mintlify/mint#9449 + mintlify/server#6963:.mintignoreconvention and CI update patternNav entry added after
graphql-setup. Follows the graphql-setup page structure.Note: the
sdkproperty on non-tab divisions is in flight in mintlify/mint#9459 — this page documents tab usage, which works today.Note
Low Risk
Documentation and navigation wiring only; no product code or runtime behavior changes.
Overview
Documents the
sdknavigation property for auto-generating SDK reference pages from TypeDoc, DocFX, Javadoc, Sphinx, and phpDocumentor artifacts.Adds
api-playground/sdk-reference-setup, covering supported formats, artifact generation commands, tab-leveldocs.jsonconfig (format,source,directory), remote HTTPS sources (including Maven Central Javadoc jars) with size limits,.mintignore, and CI refresh patterns. The page is linked in Document APIs nav (after GraphQL setup).organize/navigation.mdxgains an SDK references section (parallel to OpenAPI) with a tabsdkexample and a link to the new guide. Vale acceptsdoclet(s)?for Javadoc terminology.Reviewed by Cursor Bugbot for commit 0d2780c. Bugbot is set up for automated code reviews on this repo. Configure here.