Skip to content

docs: document SDK landing page placement in navigation - #8342

Merged
brandonmcconnell merged 1 commit into
mainfrom
autopilot/632bb5a6
Nov 7, 2026
Merged

brandonmcconnell merged 1 commit into
mainfrom
autopilot/632bb5a6

Conversation

@mintlify

@mintlify mintlify Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

SDK reference landing pages (TypeDoc README overview, lone Sphinx root page) no longer get a one-page group; the setup page and agent skill now describe where they appear in groups and tabs.

Based on a merged change to SDK reference navigation generation. Duplicate check: open docs PRs for "SDK", "Sphinx", "TypeDoc", "overview"; none found. No mint-instructions topic mentions this placement.


Note

Low Risk
Documentation-only alignment with existing SDK navigation behavior; no code or config changes.

Overview
Updates SDK reference docs to match new navigation behavior: library landing pages (TypeDoc README package-overview, or a Sphinx root page that is the only guide) are no longer wrapped in a one-page Overview or Getting Started group.

The Generated pages section on the SDK setup guide and the agent navigation skill now spell out placement: in an sdk group, the landing page sits after author-written pages and before generated groups; on an sdk tab, it goes at the end of an existing Overview group or Mintlify creates Overview for it before generated groups. Sphinx docs note the lone-root-guide case explicitly; TypeDoc copy frames the README overview as the landing page rather than always living inside an Overview group.

Reviewed by Cursor Bugbot for commit 08c20bf. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Mintlify Docs 🟢 Ready View Preview Nov 7, 2026, 10:43 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown

This PR changes the Mintlify skill but no mint instructions topic. Agents read both, so check whether the matching topic in mint-instructions/ needs the same change. If not, ignore this comment.

Changed skill file Likely topics
agent-context/context/skills/mintlify/reference/navigation.md configure/navigation

@brandonmcconnell
brandonmcconnell merged commit dfe136f into main Nov 7, 2026
7 checks passed
@brandonmcconnell
brandonmcconnell deleted the autopilot/632bb5a6 branch November 7, 2026 11:03
@mintlify mintlify Bot mentioned this pull request Nov 7, 2026

This branch was successfully deployed

1 active deployment
staging — 08c20bfe Deployed Nov 7, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant