Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yourhq.ai/llms.txt

Use this file to discover all available pages before exploring further.

The docs source lives in docs-site/.

​
Install the CLI

npm i -g mint

​
Preview locally

cd docs-site
mint dev

​
Validate

cd docs-site
node scripts/generate-llms-full.mjs
mint validate
mint broken-links

​
AI-readable docs

llms.txt is a curated index for AI assistants. llms-full.txt is generated from the Mintlify navigation in docs.json. CI checks that llms-full.txt is up to date. If a docs change reaches main without regenerating it, the Update llms-full workflow opens a follow-up PR automatically.

​
Deployment

Mintlify deploys from the /docs-site monorepo path through the Mintlify GitHub App. Production docs should be available at https://docs.yourhq.ai after the custom domain is configured.

​
Contribution rule

If a PR changes user-facing behavior, setup steps, environment variables, migrations, gateway commands, provider flows, or security assumptions, update the relevant docs page in the same PR.