DeGov.AI Documentation

Documentation site for DeGov.AI, built with MkDocs Material and deployed to docs.degov.ai via Vercel.

Structure

• docs/ — Markdown sources (the only committed content).
  • docs/governance/** — DeGov Square / Governor platform documentation.
  • docs/atlas/** — DeGov Atlas product and data documentation.
  • docs/agent-api/** — Agent API guides, concepts, migration, and reference.
  • docs/agent-skills/** — Agent skills documentation.
• mkdocs.yml — site configuration and navigation.
• site/ — generated build output (gitignored, not committed).

Local development

Use Python 3.12 so the local environment matches CI and deployment builds.

python3.12 -m venv .venv
.venv/bin/python -m pip install -r requirements.txt
.venv/bin/mkdocs serve

Open http://127.0.0.1:8000.

Building (strict)

.venv/bin/python -m pip install -r requirements.txt
.venv/bin/python -m pip check
.venv/bin/mkdocs build --strict

--strict fails on broken links, missing pages, and documentation warnings. Use it before pushing.

Deployment

• Pushes to main deploy to staging (Vercel preview).
• Tagged releases (v*) deploy to production (docs.degov.ai).

See .github/workflows/ for the exact pipeline.

Content conventions

• All public API contract facts (fields, enums, required/default, error codes) come from the OpenAPI documents generated by the backend (/openapi/*.json). Guides reference fields for workflows and do not duplicate full schemas.
• Proposed/unreleased features are marked with a not yet available admonition and must not be presented as live.
• Keep user-facing pages task-oriented: goal, prerequisites, call graph, request, response excerpt, interpretation, next actions, failure recovery.