Skip to content

Docs Parity Rules

Docs parity means the documentation, GitHub issues, project fields, PR completion reports, repository registry entries, capability maps, playbooks, prompts, ADRs, and release notes describe the same product state.

flowchart TD
    Change["Product change"]
    Vision["Product docs"]
    Registry["Repository registry"]
    Capabilities["Capability map"]
    Playbooks["Playbooks and prompts"]
    GitHub["GitHub issues and Project fields"]
    Progress["Progress and review docs"]
    ADRs["Product ADRs"]
    Releases["Releases and changes"]
    DevDocs["anuva-dev-docs publishing"]

    Change --> Vision
    Change --> Registry
    Change --> Capabilities
    Change --> Playbooks
    Change --> GitHub
    Change --> Progress
    Change --> ADRs
    Change --> Releases
    Change --> DevDocs

    Registry -. "must align" .-> Capabilities
    Capabilities -. "must align" .-> GitHub
    GitHub -. "must align" .-> Progress
    ADRs -. "must align" .-> Vision

Required Sync Points

Update product docs and registry entries together when:

  • A repository is added, removed, renamed, or changes responsibility.
  • A capability changes owner or crosses a new repository boundary.
  • A Product ADR changes architecture or a repository contract.
  • A feature moves from placeholder to active planning.
  • A release includes a user-facing product capability.
  • GitHub issues or GitHub Project fields are created or updated from product docs.
  • PR completion reports change product-level status, verification, docs impact, or integration risk.
  • Product docs should be republished through anuva-dev-docs.

Product-Main Versus Other Docs

Use this rule for Video Creator:

  • anuva-main-video-creator explains what the product needs, which repositories are affected, what GitHub issues were created, and how the feature is progressing.
  • anuvax-cms, anuva-python-server, and anuva-unity-video-creator explain how their own implementation works.
  • anuva-engineering-handbook explains shared Anuva process, ownership, templates, skills, prompts, and registry rules.
  • anuva-dev-docs publishes selected repository docs and project status for discovery.

Do not copy implementation docs into this repository. Link, summarize, or record the relevant issue, PR, and docs path instead.

Review Checklist

  • Product Architecture matches the Product Repository Registry.
  • Capability Map matches current repository responsibilities.
  • Playbooks do not contain stale repository names.
  • Prompts still produce repository-specific GitHub issues or task requests.
  • GitHubTasks.md, Progress.md, GitHub issues, PR completion reports, and GitHub Project fields match.
  • Releases and Changes reflect delivered product behavior.
  • mkdocs.yml includes new, moved, or renamed pages.
  • anuva-dev-docs publishing refresh is triggered or recorded when published docs or project status changed.

Verification

For docs-only changes in this repository:

git diff --check
mkdocs build --strict

Implementation tests should run in the owning implementation repositories, not from this product-main repository.