Skip to content

[Audit] Enforce documentation sync via CI and agent workflow gates #31

@brandon-fox

Description

@brandon-fox

Audit Finding: Documentation Not Kept in Sync

Source: Cross-repo audit (2026-02-22)

Problem

Only 3 repos (vindicta-foundation, vindicta-engine, warscribe-system) have mkdocs.yml + docs/ for generated documentation. The remaining repos have no doc infrastructure at all. When code changes land, there is no automated or workflow-enforced step to update documentation.

Doc Asset foundation engine warscribe economy oracle agents
docs/ directory
mkdocs.yml

Impact

Phase 9 (Feature 009) will add docs/ directories to all repos, but there is no mechanism to keep them in sync after creation. Documentation rot is inevitable.

Recommendation

  1. Agent workflow rule: Every PR that modifies public APIs, models, or configuration MUST include corresponding updates to docs/ and README.md.
  2. Add a docs-check CI step that runs mkdocs build --strict to catch broken internal links.
  3. The agent-task-worker workflow includes a "Documentation Gate" stage between implementation and git commit.

Repos Affected

  • vindicta-economy, vindicta-oracle, Vindicta-Agents (missing docs infrastructure)
  • All repos (missing CI enforcement of doc sync)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementImprovement to existing functionality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions