fleetlint Policy for a fleet of repositories
v0.3
Getting started

docs/architecture

Architecture is documented

Severitywarning
Tiers1
Stacksany
Scoperoot
Kindexpr
Sourcelibrary v0.0.0-20261011205826-ecb4e9b3ffd4
Selected byfleetlint-recommended@0.1.0

Requirement

docs/ARCHITECTURE.md (or an Architecture section in the README) explains the components, their boundaries and the data flow in one page.

Why

The shape of the system is the one thing a newcomer cannot recover from the code quickly.

Check

file("docs/ARCHITECTURE.md") || file("ARCHITECTURE.md") || (file("README.md") && scan("README.md", "(?i)^#+\\s*architecture").size() > 0)

Fix

Write docs/ARCHITECTURE.md: components, boundaries, data flow, the three decisions that shaped it.

Agent instruction: Write docs/ARCHITECTURE.md from the actual package structure: one paragraph per component, one diagram, no marketing.

See: https://fleetlint.org/baseline/#documentation


Generated by fleetlint docs from catalog v0.0.0-20261011205826-ecb4e9b3ffd4.