Skip to main content
These docs are built with Mintlify: edit the MDX files, preview your changes locally, and open a pull request.

​
Prerequisites

  • Node.js 20.17.0 or newer (LTS versions recommended).
  • The Mintlify CLI (mint): 
    npm i -g mint
    If you previously installed the older mintlify package, uninstall it first so the mint binary takes precedence.

​
Preview locally

From the repository root (the folder containing docs.json): 
mint dev
This serves the site at http://localhost:3000 with live reload. Prefer not to install globally? Use npx mint@latest dev.

​
Validate before you push

Two checks keep the site healthy: 
mint validate                     # strict build check — fails on warnings or errors
mint broken-links --check-anchors # report internal links and #anchors that don't resolve
mint broken-links checks page links; --check-anchors additionally validates section anchors (for example /quickstart#create-an-api-key). Run both from the repository root and make sure they are clean before opening a pull request.

​
Editing content

  • Pages are .mdx files. Each begins with a title / description frontmatter block.
  • Navigation, branding, and site settings live in docs.json.
  • Use Mintlify components — <CodeGroup>, <Card>, <Steps>, <Warning>, and friends — rather than raw HTML.

​
Assets

The logo (logo/light.svg, logo/dark.svg) and favicon.svg are placeholders. Replace them with the final Samsa brand SVGs — keep the same file paths so docs.json needs no change.

​
llms.txt

Mintlify automatically generates /llms.txt and /llms-full.txt so LLMs and agents can consume the docs — no configuration is required, and nothing in docs.json disables them. There is no need to author these files by hand.