Maintain Documentation

This is the manual version of the workflow. If you are using a coding agent, ask it to pull, edit, or preview the docs for you after completing Agent-First Onboarding.

Use this workflow for day-to-day docs maintenance.

​

Sync latest docs locally

docsalot docs pull --documentation-id <documentation-id> --out docsalot-docs

​

Edit files

Update MDX files in your local docs directory as needed.

​

Preview locally

docsalot docs preview --dir docsalot-docs --port 3000

Open http://localhost:3000 and validate structure/content before pushing.

​

Keep changes reviewable

Recommended practices:

• Use clear commit messages for docs-only commits.
• Separate structural changes from content rewrites.
• Pull again before major updates if teammates also edit docs.

​

Manage custom domains

Use custom-domain commands when you want your documentation to live at a customer-owned hostname such as docs.yourdomain.com.

docsalot domains add --documentation-id <documentation-id> --domain docs.yourdomain.com

The CLI returns the DNS record to add. After DNS is ready, verify the domain:

docsalot domains verify --documentation-id <documentation-id> --hostname-id <hostname-id>

You can also list and remove domains from the terminal:

docsalot domains list --documentation-id <documentation-id>
docsalot domains remove --documentation-id <documentation-id> --hostname-id <hostname-id>

If your DNS is on Cloudflare, read Cloudflare Custom Domains before verifying the domain.

​

Recommended pre-publish checks

• Links and images render correctly.
• Navigation still matches intended information architecture.
• No accidental deletions in edited files.