Skip to content

docs: flat hub navigation and fill out the thin pages - #22

Merged
echobt merged 0 commit into
mainfrom
droid/d75815eb-docs-flat-hub-ia-post-21
Sep 16, 2026
Merged

echobt merged 0 commit into
mainfrom
droid/d75815eb-docs-flat-hub-ia-post-21

Conversation

@echobt

@echobt echobt commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

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.json used navigation.tabs. A Mintlify tab renders a second-level switcher in the navbar, and the live site showed exactly that: a Chat dropdown 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.groups list, which is Mintlify's pattern for "one linear sidebar".

Verified against a local mint dev preview, not just the schema:

  • tabs-dropdown-trigger occurrences on / and /chat: 0
  • Rendered sidebar groups, in order, each opening its hub:
    Start here → Downloads → Chat → Code → Bot → CLI → Design → API → Help → Changelog

Each 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.
  • Thin pages filled, using only facts already documented in this tree:
    • 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 its skill tool, and why loading one grants no permissions
    • design/canvases, design/library — who can open one, what each library item is for
    • chat/canvases — what a canvas turn can actually write to, including the design_write / design_read tools
    • security/overview — which product can reach which surface
    • platform — what to use instead of the Platform API
    • code/interactions, code/cloud, bot/routines, chat/library, chat/origin-check, chat/streaming, chat/sharing, api/overview, getting-started/desktop
  • Every page now closes with a Related or Next section. 26 pages lacked one — the 24 problem pages, index, and cli/quickstart.
  • Trimmed the last two descriptions to fit under 160 characters.
  • Added the missing Keyboard shortcuts card to the CLI hub.

Comp gates

  • No competitor names, no "like X" comparisons — in titles, commits, page copy, or docs.json. Scanned mechanically.
  • Security page keeps its disclaimer: no claimed SOC 2, GDPR certification, or HIPAA. That wording is unchanged, and the surrounding paragraph now says plainly that there is no certification claim to read.
  • No fake features. Every addition is grounded in a fact already stated elsewhere in this repo; nothing was invented.
  • Chat / Code / Bot / CLI / Design honesty gates hold — each product's boundaries are stated, and no page claims a capability another page denies.
  • No audits or research dumps in the repo.
  • English product copy, Cortex names and domains only.
  • Home + Documentation navbar and ink-on-cream CTAs untouched.
  • No auth, OAuth, session, identity-provider, private-route, credential, farm, or operator content.

Validation

All run locally and green:

node scripts/check-docs-site.mjs
bash scripts/tests/check-docs-site.test.sh
node scripts/tests/docs-ui.test.mjs
npm exec --yes --package=mint@4.2.876 -- mint validate

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.mjs now fails if tabs, dropdowns or products come back, and asserts that each product group opens its hub page — so the dropdown cannot quietly return.

Not in this PR

Follow-ups

  • Member-only surfaces still have no screenshots (Code session timeline, Bot setup form and Computer rail, Design canvas, Bot desktop app). images/product/README.md tracks them; this PR adds no fake art.
  • platform.mdx will need a real reference if the inference API ships.

@mintlify

mintlify Bot commented Sep 15, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
cortex-foundation-add13747 🟢 Ready View Preview Sep 15, 2026, 11:27 PM

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

@echobt

echobt commented Sep 15, 2026

Copy link
Copy Markdown
Contributor Author

@greptileai review

Draft PR for Comp + Mathis review. Docs-only, no merge until they give the GO.

@echobt
echobt merged commit 8a077c7 into main Sep 16, 2026
5 checks passed
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