Skip to main content

Cortex public documentation

This is the Mintlify site for docs.cortex.foundation. Edit the site at the repository root, not in apps/docs. Preview and validation commands are in README.md.
  • Keep product copy in English and use the Cortex product names and domains.
  • Do not publish authentication/session internals, credentials, private API routes, farm details, or backend operator runbooks.
  • Preserve the Home + Documentation navbar and ink-on-cream CTAs.
  • Keep navigation a flat list of top-level groups (navigation.groups). navigation.tabs renders a product dropdown in the navbar; the hubs already are that second level, so a tab makes the reader pick Chat twice.
  • Keep every navigation slug backed by a page and every problem page’s type URL on https://docs.cortex.foundation/problems/{code}.
  • One hub page per product (<product>/index.mdx). Do not add a second overview page beside it, and give every page a title, a description, and a closing Related or Next section.
  • Keep description under 160 characters so it is not truncated in search results and link previews. Where the product’s sidebar label differs from the page title (the sidebar says Artifacts, the page is Library), add the label to keywords so either term finds the page.
  • Run node scripts/check-docs-site.mjs and bash scripts/tests/check-docs-site.test.sh, then node scripts/tests/docs-ui.test.mjs and npm exec --yes --package=mint@4.2.876 -- mint validate before committing.
  • For error-code or endpoint changes, also run the checker with a backend checkout as its first argument. Coordinate the two PRs; the backend owns the API contract and checks this repository in its CI.
  • Do not change the Mintlify integration, custom domain, or DNS without an explicit request.