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

# Deploy Mintlify

> Connect the Atoll docs repository to Mintlify, configure docs.atollhq.com, add DNS, and verify the public docs.

Use this checklist to publish the Atoll docs site.

## Repository settings

In Mintlify, connect the Atoll GitHub repository and set:

| Setting     | Value                              |
| ----------- | ---------------------------------- |
| Repository  | `antons-agents/atoll`              |
| Branch      | `main` after the docs PR is merged |
| Docs root   | `docs-site`                        |
| Config file | `docs-site/docs.json`              |

## Custom domain

Use:

```text theme={null}
docs.atollhq.com
```

Mintlify will provide the DNS target after you add the custom domain in the dashboard. Add the DNS record exactly as Mintlify shows it.

Typical setup:

| Type    | Host   | Value                    |
| ------- | ------ | ------------------------ |
| `CNAME` | `docs` | Mintlify-provided target |

## Pre-deploy validation

Run from the repository root:

```bash theme={null}
cd docs-site
npm run validate
npm run broken-links
```

## Post-deploy checks

After Mintlify deploys, check:

```text theme={null}
https://docs.atollhq.com
https://docs.atollhq.com/llms.txt
https://docs.atollhq.com/llms-full.txt
https://docs.atollhq.com/openapi.json
```

## PR workflow

For future docs changes:

1. Create a branch.
2. Edit files under `docs-site/`.
3. Run `npm run validate`.
4. Run `npm run broken-links`.
5. Open a PR.
6. Merge to `main` after review.

<Note>
  Do not connect Mintlify to the repository root unless the docs root is configured as `docs-site`; the Next.js app and packages live outside the docs site.
</Note>