Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions agent-context/context/skills/mintlify/reference/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ Generate SDK reference pages from documentation-tool build artifacts by adding a
Format-specific behavior:

- **Javadoc:** Pages are grouped by package. A package with several kinds nests them under Interfaces, Classes, Enums, Records, Exceptions, Errors, and Annotations.
- **Sphinx:** Guide pages go under a Getting Started group and module pages under an API Reference group. Packages nest their modules in groups that follow the Sphinx toctree, and a page with several `module-*` sections is split into one child page per module.
- **Sphinx:** Guide pages go under a Getting Started group and module pages under an API Reference group. If the root page is the only guide page, it becomes the library's landing page instead of a one-page Getting Started group. Packages nest their modules in groups that follow the Sphinx toctree, and a page with several `module-*` sections is split into one child page per module.
- **Go:** Generate the artifact with `go run github.com/mintlify/mintlify-go-extractor@latest -o go.json` from inside the module. `-exclude` skips packages by pattern. `-exclude-symbols` takes comma-separated patterns such as `NewLegacyClient`, `Client.Debug`, `option.WithDebugLog`, or `Legacy*` to leave symbols out; references to excluded symbols show as plain text. Pages are grouped by package, with the package overview first. A package with several kinds nests the rest under Interfaces, Structs, Types (defined types and aliases), and Functions (constructors included).

```json
Expand All @@ -371,7 +371,7 @@ Format-specific behavior:
}
```

A tab with `sdk` can include `groups` but not `pages`, `versions`, `languages`, `openapi`, `asyncapi`, or `graphql`. A group with `sdk` can include `pages` and nested groups but not `graphql`. Author-written `pages` render first, followed by the generated reference groups. For TypeDoc, `@category` and `@group` tags define the generated groups, and nested categories and namespaces become nested groups. Without those tags, Mintlify groups pages by symbol type. When the TypeDoc artifact embeds a README, Mintlify adds an overview page (`package-overview` under the `directory`) in an **Overview** group before the symbol groups, with the README prose followed by an index of the symbols. A module with its own README gets a `<module>/package-overview` page in a **<Module> Overview** group. Artifacts without a README, or with an empty one, generate no overview page. Use multiple tabs or groups with unique `directory` values to document multiple libraries (for example, stable and beta versions in the same tab).
A tab with `sdk` can include `groups` but not `pages`, `versions`, `languages`, `openapi`, `asyncapi`, or `graphql`. A group with `sdk` can include `pages` and nested groups but not `graphql`. Author-written `pages` render first, followed by the generated reference groups. A library landing page (the TypeDoc README overview or a lone Sphinx root page) gets no group of its own: in an `sdk` group it follows the author-written `pages`, before the generated groups; in an `sdk` tab it joins the end of an author-defined **Overview** group, or Mintlify adds an **Overview** group for it before the generated groups. For TypeDoc, `@category` and `@group` tags define the generated groups, and nested categories and namespaces become nested groups. Without those tags, Mintlify groups pages by symbol type. When the TypeDoc artifact embeds a README, Mintlify adds an overview page (`package-overview` under the `directory`) as the landing page, with the README prose followed by an index of the symbols. A module with its own README gets a `<module>/package-overview` page in a **<Module> Overview** group. Artifacts without a README, or with an empty one, generate no overview page. Use multiple tabs or groups with unique `directory` values to document multiple libraries (for example, stable and beta versions in the same tab).

```json
{
Expand Down
6 changes: 5 additions & 1 deletion api-playground/sdk-reference-setup.mdx
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, phpDocumentor, or Go 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", "go", "golang", "mintlify-go-extractor", "reference"]
---

Expand Down Expand Up @@ -84,8 +84,8 @@
"tab": "SDK Reference",
"sdk": {
"format": "typedoc",
"source": "sdk-artifacts/typedoc.json",

Check warning on line 87 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#L87

Use 'SDK' instead of 'sdk'.
"directory": "sdk/typescript"

Check warning on line 88 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#L88

Use 'TypeScript' instead of 'typescript'.
}
}
]
Expand Down Expand Up @@ -137,9 +137,13 @@

Mintlify adds the generated navigation groups after any `groups` on the tab. If you add `sdk` to a group, the generated groups appear after that group's `pages`. The groups vary by format and may represent modules, packages, namespaces, or symbol types.

Some artifacts produce a landing page for the library, such as a TypeDoc README overview or a Sphinx root page. Mintlify places the landing page without a group of its own. If you add `sdk` to a group, the landing page appears after that group's `pages` and before the generated groups. If you add `sdk` to a tab, Mintlify adds the landing page to the end of the tab's `Overview` group if you defined one. Otherwise, Mintlify adds an `Overview` group for it before the generated groups.

Check warning on line 140 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#L140

Use 'ReadMe' instead of 'README'.

For Sphinx artifacts, guide pages go in a `Getting Started` group and module pages go in an `API Reference` group. If the root page is the only guide page, Mintlify uses it as the landing page instead of a one-page `Getting Started` group.

For TypeDoc artifacts, Mintlify follows the layout you define with `@category` and `@group` tags. Categories and custom group titles become navigation groups. Categories inside a group become nested groups, and namespaces become nested groups that follow their own categories or groups. If the artifact has no categories or custom group titles, Mintlify groups pages by symbol type, such as classes, interfaces, and functions.

If your TypeDoc artifact includes a README, Mintlify adds an overview page at `package-overview` under your `directory`, in an `Overview` group before the other generated groups. The overview page shows the README, followed by an index of the library's classes, interfaces, functions, and other symbols. A module with its own README gets a separate overview page at `<module>/package-overview`, in a `<module> Overview` group, that indexes only that module's symbols. Artifacts without a README, or with an empty one, get no overview page.
If your TypeDoc artifact includes a README, Mintlify adds an overview page at `package-overview` under your `directory` and uses it as the landing page. The overview page shows the README, followed by an index of the library's classes, interfaces, functions, and other symbols. A module with its own README gets a separate overview page at `<module>/package-overview`, in a `<module> Overview` group, that indexes only that module's symbols. Artifacts without a README, or with an empty one, get no overview page.

Check warning on line 146 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#L146

Use 'ReadMe' instead of 'README'.

Check warning on line 146 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#L146

Use 'ReadMe' instead of 'README'.

Check warning on line 146 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#L146

Use 'ReadMe' instead of 'README'.

Check warning on line 146 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#L146

Use 'ReadMe' instead of 'README'.

For Javadoc artifacts, Mintlify groups pages by package. When a package mixes kinds, it nests them under Interfaces, Classes, Enums, Records, Exceptions, Errors, and Annotations in the order Javadoc uses on its package pages.

Expand Down
Loading