fabro/docs
Bryan Helmkamp 2cce052f9f Add DOT docs test suite and fix invalid DOT in docs examples
Extract all 29 full digraph workflows from docs into test/docs/ with
an extraction script, assemble 7 snippet DOTs from reference pages,
and add a runner script for validate/dry-run/haiku/full phases.

Docs fixes:
- definition-of-done: replace multi-word condition values with
  underscored equivalents (parser doesn't support spaces), make
  safe-default edges unconditional for fallback coverage
- semantic-port: make fallback edges unconditional on fetch/analyze
  nodes so validator doesn't reject all-conditional-edge nodes

All 36 DOTs pass `arc validate`.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-06 14:55:56 -05:00
..
administration Per-request demo mode with UI toggle 2026-03-06 07:30:23 -05:00
agents Fill in tutorials, examples, and reference docs with content and SVGs 2026-03-05 22:14:02 -05:00
api-reference Return structured JSON for run config and server config 2026-03-06 14:04:57 -05:00
changelog Switch Daytona git cloning from gh CLI to GitHub App Installation Access Tokens 2026-03-05 22:31:40 -05:00
core-concepts Add GPT-5.4 and GPT-5.4 Pro to model catalog 2026-03-05 22:12:21 -05:00
deployment Scaffold Mintlify docs site with full navigation structure 2026-03-03 10:33:09 -05:00
examples Add DOT docs test suite and fix invalid DOT in docs examples 2026-03-06 14:55:56 -05:00
execution Rename final.json to conclusion.json and RunFinal to Conclusion 2026-03-06 10:48:07 -05:00
getting-started Per-request demo mode with UI toggle 2026-03-06 07:30:23 -05:00
images Add SVGs and simplify DoD example to two specs 2026-03-06 09:13:01 -05:00
languages Add custom TextMate grammar for DOT syntax highlighting in docs 2026-03-05 21:41:54 -05:00
logo agent-design-memo.md 2026-03-03 12:44:28 -05:00
reference Apply API design guidelines to all non-Session endpoints 2026-03-06 10:30:33 -05:00
tutorials Fill in tutorials, examples, and reference docs with content and SVGs 2026-03-05 22:14:02 -05:00
workflows Implement per-node max_visits override for loop detection 2026-03-05 22:05:11 -05:00
.mintignore Fix Mintlify dev server: valid navbar URL and ignore AGENTS.md 2026-03-05 16:29:50 -05:00
AGENTS.md Add mintlify docs 2026-03-02 09:59:44 -05:00
CONTRIBUTING.md Add mintlify docs 2026-03-02 09:59:44 -05:00
docs.json Add Definition of Done example workflow to docs 2026-03-06 08:42:10 -05:00
favicon.svg Add mintlify docs 2026-03-02 09:59:44 -05:00
LICENSE Add mintlify docs 2026-03-02 09:59:44 -05:00
README.md Add mintlify docs 2026-03-02 09:59:44 -05:00

Mintlify Starter Kit

Use the starter kit to get your docs deployed and ready to customize.

Click the green Use this template button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with

  • Guide pages
  • Navigation
  • Customizations
  • API reference pages
  • Use of popular components

Follow the full quickstart guide

AI-assisted writing

Set up your AI coding tool to work with Mintlify:

npx skills add https://mintlify.com/docs

This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.

See the AI tools guides for tool-specific setup.

Development

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

npm i -g mint

Run the following command at the root of your documentation, where your docs.json is located:

mint dev

View your local preview at http://localhost:3000.

Publishing changes

Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

Need help?

Troubleshooting

  • If your dev environment isn't running: Run mint update to ensure you have the most recent version of the CLI.
  • If a page loads as a 404: Make sure you are running in a folder with a valid docs.json.

Resources