Search docs

Docs search
Back to Rule Catalog
AP-ARCH-003Architecture

Architecture overview artifact exists

Checks that the architecture overview document exists.

errorsetup-gapNo auto-fix

How to fix

  1. Create or restore the architecture overview.
  2. Update configuration if the overview lives elsewhere.
  3. Include system boundaries, modules, tenant model, and validation responsibilities.

What the rule validates

ArchPilot could not find the architecture overview artifact expected by the project configuration.

Why it matters

The overview connects local validation results to human-readable system context.

Common causes

  • docs/architecture/overview.md is missing.
  • The overview moved to another path.
  • The repository was initialized without committing generated docs.

Typical violation example

Validation is configured but no architecture overview is present.

Typical compliant example

docs/architecture/overview.md summarizes modules, data flow, and governance boundaries.

Related rules

Adjacent categories

Related files/config

  • docs/architecture/overview.md
  • .archpilot/architecture.json

Related CLI commands

  • archpilot validate
  • archpilot validate --ci
AP-ARCH-003 - Architecture overview artifact exists | ArchPilot Docs