> ## Documentation Index
> Fetch the complete documentation index at: https://fastql.vachagan.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Documentation workflow

> Run, validate, and update the Mintlify documentation project.

The Mintlify project is isolated under `docs/` and requires Node.js 20.17 or newer.

```bash theme={null}
cd docs
npm ci
npm run dev
```

The local preview command prints the URL selected by Mint. Before submitting changes,
run all documentation checks:

```bash theme={null}
npm run validate
npm run links
npm run a11y
```

Repository tests also verify navigation completeness, frontmatter, runnable examples,
and capability-catalog coverage:

```bash theme={null}
uv run pytest tests/test_documentation.py
```

Add pages to `docs/docs.json`, keep public claims aligned with the canonical OpenSpec
files, and include descriptive alt text for images. Custom landing-page styles belong
in `docs/style.css`; technical content should use standard MDX components.

The production site is published at
[fastql.vachagan.dev](https://fastql.vachagan.dev). See the repository's
[`docs/README.md`](https://github.com/MyGenX/FastQL/blob/main/docs/README.md) for the
Mintlify monorepo, deployment, and custom-domain procedure. Deployment credentials and
DNS-provider access remain outside the repository.