Skip to content

[T-006b] Docs workflow docs.yml: markdownlint, Mermaid render check, lychee links, ADR index check #29

Closed

Description

@CodewithJha

Task T-006b · Milestone M1 — Foundation · Size S · Priority P1 · Epic #1

Implements NFR-MNT-001

Branch ci/t-006b-docs-workflow-markdownlint-mermaid-render — one task = one branch = one PR (doc 32 §6)

Summary

Automate documentation quality so the specification (the agents' source of truth) never silently breaks: every Mermaid block renders, links resolve, Markdown is linted and the ADR index lists every ADR.

Context / motivation

The docs are normative for AI agents (AGENTS.md). Broken diagrams or links directly degrade implementation quality.

Scope

In scope

  • scripts/check_docs.sh (also make docs-check): markdownlint-cli2 with .markdownlint.jsonc, mermaid-cli (mmdc) rendering every fenced mermaid block (via scripts/check_mermaid.sh), lychee link check (offline mode for repo links, online for external with retries), scripts/check_adr_index.py comparing docs/adr/*.md with the index in doc 15 §2 / docs/adr/README.md.
  • .github/workflows/docs.yml triggered on docs/**, *.md changes.

Implementation guidance

  • Mermaid CLI needs Chromium: use the minlag/mermaid-cli container or npx @mermaid-js/mermaid-cli with puppeteer config --no-sandbox in CI. Make markdownlint rules pragmatic (allow long lines in tables).
  • Standards: respect the layering contracts (doc 16 §2) and conventions in doc 34; no hard-coded tunables — thresholds/defaults come from typed settings (doc 27); no magic numbers (ruff PLR2004); public APIs typed (mypy strict) and documented.

Acceptance criteria

  • make docs-check passes on current main (fix any genuine issues found).
  • A broken Mermaid block or dead relative link fails the workflow.
  • Duration ≤ 3 min.
  • Tests listed below added and green in CI; coverage of new code meets the gate in doc 18 §3.
  • Docs, config reference and CHANGELOG Unreleased updated where behaviour, keys or interfaces changed.
  • Definition of Done (doc 32 §3) satisfied.

Tests required

  • Workflow run on a PR touching docs.

Dependencies

Blocked by: #12 (T-001)

Blocks: no other task (leaf)

Parallelization notes

Files / paths owned by this task — avoid editing other paths; shared files (pyproject.toml entry points, cli/main.py, api/routers/__init__.py, router.tsx, docker/compose.yaml, ci.yml) are append-only:

  • scripts/check_docs.sh
  • scripts/check_mermaid.sh
  • scripts/check_adr_index.py
  • .markdownlint.jsonc
  • lychee.toml
  • .github/workflows/docs.yml
  • Makefile (docs-check)

Independent of all code tasks.

Definition of Done

Per doc 32 §3 and AGENTS.md §5: lint, format, mypy strict and import-linter green; tests added and passing; docs updated; PR template completed with Closes #<this issue>; Conventional Commit messages referencing T-006b (doc 16 §6); commits authored only by the repository owner identity (AGENTS.md §4); CI green; reviewer checklist (doc 32 §5.1) satisfied.

References

Design docs: doc 20 §1 · doc 18 §2 · doc 32 §7

Requirements: NFR-MNT-001 (traceability: doc 28)

External:

Activity

  1. added this to the M1 — Foundation milestone on Nov 19, 2026
  2. added
    help wantedExtra attention is needed
    type:infraCI, build, deployment infrastructure
    area:ciCI/CD workflows
    priority:P1Required for milestone exit
    taskChild task of a milestone epic
    on Nov 19, 2026
  3. 16 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:ciCI/CD workflowsarea:docsDocumentationhelp wantedExtra attention is neededmilestone:M1M1 — Foundationpriority:P1Required for milestone exitsize:S<= 1 daytaskChild task of a milestone epictype:infraCI, build, deployment infrastructure

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions