updated_at	2026-07-19 02:04:50 +0700

TodoPro Public Docs

Customer-facing documentation for TodoPro, published at https://docs.todopro.xyz.

This repo holds end-user help content only — getting started, feature guides, FAQ, troubleshooting. Internal engineering documentation (ADRs, epics, specs, runbooks) lives in a separate repo and is published internally.

Stack

• Zensical static site generator (successor to Material for MkDocs)
• Configuration in zensical.toml, content in docs/
• Served in production by static-web-server on port 8080

Local development

mise run install   # uv sync
mise run serve     # http://localhost:8000, live reload
mise run build     # static output into ./site

Without mise:

uv sync
uv run zensical serve

Publishing

Pushing to main runs the org-wide reusable workflow (minhdqdev-org/github-actions-workflows/.github/workflows/ci.yml), which builds the image and pushes it to Harbor as minhdqdev/todopro-public-docs:<version> and :latest. ArgoCD Image Updater watches the latest digest and rolls out the new revision automatically.

The version comes from [project] version in pyproject.toml — that is what the shared workflow reads. Bump it on every change to main so each release gets a distinct immutable tag; if it is ever missing the workflow silently falls back to a short commit SHA.

Writing guidelines

• Second person, short sentences, task-oriented headings.
• Every page needs YAML frontmatter with title, description, and updated_at (ISO 8601, UTC+7).
• Mark Pro-only features with an !!! info "Pro feature" admonition.
• Use Mermaid fences for diagrams.
• Link between pages with relative .md paths.
• Never reference internal hostnames, internal repos, or engineering jargon.