diff --git a/api-playground/sdk-reference-setup.mdx b/api-playground/sdk-reference-setup.mdx index a576de74b..c414fb6e5 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 `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.