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:
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:
cd docs-site
npm run validate
npm run broken-links
Post-deploy checks
After Mintlify deploys, check:
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:
- Create a branch.
- Edit files under
docs-site/.
- Run
npm run validate.
- Run
npm run broken-links.
- Open a PR.
- Merge to
main after review.
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.
