PPS / template

PROJECT-READMAP.toml

Prioritize the files a person or agent should read to understand a project.

DownloadView source file Read related standard

Useful when

My project keeps drifting.

Choose your situation

What you should change

Replace project names, mandatory paths, ranks and file budgets. This is a reading map, not a milestone roadmap.

Use only the parts that help. These are starting points, not rigid requirements.

View resource

schema = "cityhall.project-readmap"
version = "1.0"

[project]
name = "{{PROJECT_NAME}}"
generated_by = "{{GENERATED_BY}}"

[budget]
analyzer_file_budget = 25
reserved_mandatory = 4
remaining_exploratory = 21

[[mandatory]]
path = "{{PROJECT_MANIFEST}}"
rank = 1
reason = "Canonical machine-readable project metadata"

[[mandatory]]
path = "Project-Proposal.md"
rank = 2
reason = "PPS project intent, scope, boundaries, and version shape"

[[mandatory]]
path = "Project-README.md"
rank = 3
reason = "Canonical project overview and operator context"

[[mandatory]]
path = "AGENTS.md"
rank = 4
reason = "Project-local agent instructions"

[[priority]]
path = "docs/ARCHITECTURE.md"
rank = 5
reason = "Current architecture and implementation model, when established"

[[priority]]
path = "docs/RELEASE.md"
rank = 6
reason = "Release posture and evidence summary, when applicable"

[[evidence]]
path = "artifacts/"
reason = "Generated project artifacts and verification evidence"

[[secondary]]
path = "docs/"
reason = "Supporting project documentation"

[[exclude]]
path = "node_modules/"
reason = "Generated dependency tree"

[[exclude]]
path = "dist/"
reason = "Generated frontend build output"

[[exclude]]
path = "src-tauri/target/"
reason = "Generated Tauri/Rust build output"