From bde96cfb3cdbd16a386fdc00e173401e4337b357 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 24 Jul 2026 13:46:18 -0700 Subject: [PATCH 1/2] Clarify SDK reference setup behavior --- api-playground/sdk-reference-setup.mdx | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/api-playground/sdk-reference-setup.mdx b/api-playground/sdk-reference-setup.mdx index a576de74b..7fa0a5c2b 100644 --- a/api-playground/sdk-reference-setup.mdx +++ b/api-playground/sdk-reference-setup.mdx @@ -65,24 +65,34 @@ Add an `sdk` property to a tab in your `docs.json`. Mintlify parses the artifact } ``` - + + 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. + + + The documentation tool that produced the artifact: `typedoc`, `docfx`, `javadoc`, `sphinx`, or `phpdoc`. - + - - Relative path to the artifact file or directory in your docs repository, or an HTTPS URL. - + + Relative path to the artifact file or directory in your docs repository, or an HTTPS URL. Does not accept HTTP URLs. + - + The URL path prefix for generated pages. Defaults to `sdk-reference`. - + -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. Add your artifact directory to [`.mintignore`](/organize/mintignore) so Mintlify treats artifacts as build inputs rather than publishing them as static assets. +## Generated pages + +Mintlify adds the generated navigation groups after any hand-written `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. From 79e695208d7e7c9045cd44faa1386120d1da0b32 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 24 Jul 2026 15:09:17 -0700 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=92=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api-playground/sdk-reference-setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-playground/sdk-reference-setup.mdx b/api-playground/sdk-reference-setup.mdx index 7fa0a5c2b..c414fb6e5 100644 --- a/api-playground/sdk-reference-setup.mdx +++ b/api-playground/sdk-reference-setup.mdx @@ -89,7 +89,7 @@ Add multiple tabs to document multiple libraries. Use a unique `directory` for e ## Generated pages -Mintlify adds the generated navigation groups after any hand-written `groups` on the tab. The groups vary by format and may represent modules, packages, namespaces, or symbol types. +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.