Skip to content

docs(phase-4): add docs-code consistency tests and final polish #229

Description

@S1M0N38

Part of #224 — v2 docs rewrite (Diátaxis).

Goal

Drift-proofing + final QA before merge.

Tasks

  • Add tests/cli/test_docs.py (openrpc ↔ api.md, typer ↔ cli.md, config env vars ↔ cli.md, link checker)
  • Update llmstxt config + regenerate llms.txt / llms-full.txt; verify with an LLM client
  • Run make format + make quality; fix mdformat issues
  • Full docs review pass: every page read for tone consistency (Diátaxis: no quadrant mixing)

Dependencies

Done when

  • CI green with the new docs test
  • llms.txt regenerated and LLM-verified
  • Zero mdformat/quality failures

Activity

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions