Skip to content

SDK reference polish #6741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 2 commits into from
Jul 24, 2026
Merged

SDK reference polish #6741

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bde96cf
Clarify SDK reference setup behavior
ethanpalm Jul 24, 2026
79e6952
💅
ethanpalm Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions api-playground/sdk-reference-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Generate SDK reference pages from doc-tool output"
sidebarTitle: "SDK reference setup"
description: "Publish SDK reference documentation in Mintlify from TypeDoc, DocFX, Javadoc, Sphinx, or phpDocumentor artifacts using the sdk navigation property."

Check warning on line 4 in api-playground/sdk-reference-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/sdk-reference-setup.mdx#L4 

Use 'SDK' instead of 'sdk'.
keywords: ["sdk", "typedoc", "docfx", "javadoc", "sphinx", "phpdocumentor", "reference"]
---

Expand Down Expand Up @@ -65,24 +65,34 @@
}
```

<ResponseField name="format" type="string" required>
<Note>
You must declare `sdk` on a [tab](/organize/navigation#tabs). 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.
</Note>

<ParamField path="format" type="string" required>
The documentation tool that produced the artifact: `typedoc`, `docfx`, `javadoc`, `sphinx`, or `phpdoc`.
</ResponseField>
</ParamField>

<ResponseField name="source" type="string" required>
Relative path to the artifact file or directory in your docs repository, or an HTTPS URL.
</ResponseField>
<ParamField path="source" type="string" required>
Relative path to the artifact file or directory in your docs repository, or an HTTPS URL. Does not accept HTTP URLs.
</ParamField>

<ResponseField name="directory" type="string">
<ParamField path="directory" type="string">
The URL path prefix for generated pages. Defaults to `sdk-reference`.
</ResponseField>
</ParamField>

Add multiple tabs to document multiple libraries. Each tab needs a unique `directory`.
Add multiple tabs to document multiple libraries. Use a unique `directory` for each library to avoid route collisions.

<Tip>
Add your artifact directory to [`.mintignore`](/organize/mintignore) so Mintlify treats artifacts as build inputs rather than publishing them as static assets.
</Tip>

## Generated pages

Mintlify adds the generated navigation groups after any `groups` 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

Set `source` to an HTTPS URL to fetch the artifact at build time instead of committing it to your docs repository.
Expand Down