sdk navigation property to generate reference pages for your SDK libraries from the documentation tools you already run. Mintlify reads each tool’s build artifact and creates a page for every class, interface, module, and function, with navigation groups, cross-page links, and search indexing included.
Supported formats
Generate an artifact
Run your documentation tool with a machine-readable output format. If you already publish generated docs from CI, this is usually a one-flag change to the same command.Auto-populate SDK pages
Add ansdk property to a tab in your docs.json. Mintlify parses the artifact and creates navigation groups and pages for the library.
You must declare
sdk on a tab. A tab with sdk may include groups, but no other navigation structures, such as pages, versions, or languages. It also cannot include an openapi, asyncapi, or graphql property.string
required
The documentation tool that produced the artifact:
typedoc, docfx, javadoc, sphinx, or phpdoc.string
required
Relative path to the artifact file or directory in your docs repository, or an HTTPS URL. Does not accept HTTP URLs.
string
The URL path prefix for generated pages. Defaults to
sdk-reference.directory for each library to avoid route collisions.
Generated pages
Mintlify adds the generated navigation groups after anygroups on the tab. The groups vary by format and may represent modules, packages, namespaces, or symbol types.
Each generated page documents a class, interface, function, type, or other symbol from the artifact and links to related generated pages. If a converter produces pages that do not belong to a group, Mintlify collects them under a Reference group.
Use remote sources
Setsource to an HTTPS URL to fetch the artifact at build time instead of committing it to your docs repository.
Single-file formats (typedoc, phpdoc) accept a direct file URL. Directory formats (docfx, javadoc, sphinx) accept a zip archive. Javadoc jars published to Maven Central work without repackaging:
Keep references up to date
Regenerate the artifact whenever your SDK changes. A common pattern is a CI job in each SDK repository that runs the documentation tool on release. The job either commits the artifact to your docs repository or uploads it to a stable URL thatsource points to.
Where do the docs and code live?
Your SDK code does not need to live in the same repository as your docs. Pick the pattern that matches your setup.SDK and docs in the same repository
The simplest setup. Generate the artifact in the same repository as your docs and pointsource at its relative path. Any workflow that already produces the artifact on push or release can commit it back to the repository, and the next docs deployment picks it up automatically.
This works for a monorepo that contains both the SDK source and the docs.
SDK in a separate repository
When the SDK lives in its own repository, you have two options.-
Commit the artifact to your docs repository. In the SDK repository, run a CI job on release that generates the artifact and opens a pull request (or pushes a commit) to your docs repository with the updated file. Merging that change to your deployment branch triggers a docs deployment on its own, so no extra API call is needed. Point
sourceat the committed path, the same as the single-repository setup. -
Host the artifact and fetch it at build time. Upload the artifact to a stable HTTPS URL (for example, an S3 bucket, GitHub Releases asset, or Maven Central for Javadoc jars) and set
sourceto that URL. Because nothing changes in your docs repository when the SDK updates, you also need to trigger a docs deployment so the new artifact is fetched. Call the Trigger deployment endpoint from your SDK release pipeline after the artifact is published. See Remote artifact limits for size constraints.