docs: flat hub navigation and fill out the thin pages - #22
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
Author
|
@greptileai review Draft PR for Comp + Mathis review. Docs-only, no merge until they give the GO. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this is
Follow-up to #21 (merged at
36440a0). Two things were still wrong after that pass: the sidebar opened on a product switcher rather than on the products themselves, and a handful of pages stopped short of the questions their own titles raise.Docs-only. No backend, product, or config code is touched.
This PR is intentionally a draft. Do not merge.
Why the navigation changed
docs.jsonusednavigation.tabs. A Mintlify tab renders a second-level switcher in the navbar, and the live site showed exactly that: aChatdropdown trigger sitting next to the logo (data-component-part="tabs-dropdown-trigger"). The product hubs already are that second level, so a reader was being asked to pick Chat twice — once in the navbar, once in the sidebar.The fix is one flat
navigation.groupslist, which is Mintlify's pattern for "one linear sidebar".Verified against a local
mint devpreview, not just the schema:tabs-dropdown-triggeroccurrences on/and/chat: 0Start here → Downloads → Chat → Code → Bot → CLI → Design → API → Help → ChangelogEach product is now one flat group — hub, its pages in reading order, its troubleshooting page last. The nested groups that used to sit inside Chat, Code, Bot and CLI are gone. The problem catalog stays nested under API, because 24 reference pages are not a product tour.
Content
design/troubleshooting.mdx(new) — Design was the only product with no troubleshooting page while Chat, Code, Bot and CLI each had one.chat/voice— where voice does and does not exist (Chat only; no CLI, Code, Bot or Design equivalent)bot/skills— how a bot reaches a skill through itsskilltool, and why loading one grants no permissionsdesign/canvases,design/library— who can open one, what each library item is forchat/canvases— what a canvas turn can actually write to, including thedesign_write/design_readtoolssecurity/overview— which product can reach which surfaceplatform— what to use instead of the Platform APIcode/interactions,code/cloud,bot/routines,chat/library,chat/origin-check,chat/streaming,chat/sharing,api/overview,getting-started/desktopindex, andcli/quickstart.Comp gates
docs.json. Scanned mechanically.Validation
All run locally and green:
Also checked mechanically: 0 broken internal links, 0 orphan pages, 0 dead navigation slugs, 0 duplicate titles, 0 descriptions over 160 characters, 0 redirects pointing at a missing page, and no product screenshot used on more than one page.
The backend contract check (
node scripts/check-docs-site.mjs ../backend) was not run here; it needs a backend checkout. No error code or endpoint changed, so no coordinated backend PR is required.docs-ui.test.mjsnow fails iftabs,dropdownsorproductscome back, and asserts that each product group opens its hub page — so the dropdown cannot quietly return.Not in this PR
Follow-ups
images/product/README.mdtracks them; this PR adds no fake art.platform.mdxwill need a real reference if the inference API ships.