Repository navigation
Commit b4c3360
committed
docs(governance): adopt rules + lifecycle from PaySpace analytics docs; add glossary, plans/ folder, and an enforcement rule
Lifts the high-signal subset of the analytics docs governance pattern:
- Rules for Agents (numbered, normative — cite by number in PR review)
- Document Lifecycle (4 doc types: Reference / Roadmap / Plan / Research)
- Existence test for whether a doc earns its place
- Top-level cap rule
- Closing rules for research notes (codifies what we did manually for
competitive-scan-2026-04.md)
docs/README.md
- Restructure into File Ownership → Rules for Agents → Single Source of
Truth → Document Lifecycle → Naming Conventions → Conventions.
- Move existing "Conventions" prose to the bottom as a stylistic
addendum to the rules above.
- Add 9 numbered rules (one source of truth, ship-flow, plans, table
freshness, relative paths, no inventory counts, no line-numbers,
research closing, glossary updates).
- Add Document Lifecycle section with 4 doc types, the existence test,
closing-research rules, and the top-level cap.
- Add `glossary.md`, `plans/`, `research/` rows to File Ownership.
- Add "Domain term definitions" + "Non-goals" rows to Single Source of
Truth (canonical = glossary.md / roadmap.md, others link).
docs/glossary.md (new)
- ~70 entries covering schema/parser/recipe/agent terminology.
- Disambiguates pairs that look similar: FileRow vs `files` table, recipe
vs query, schema vs DDL, hub vs barrel-file, fan-in vs fan-out, parser
vs adapter, plan vs research, rule vs skill.
- Links recipe + table entries back to architecture.md schema sections
for deep details (Rule 1 — one source of truth).
docs/plans/.gitkeep (new)
- Empty folder so the convention is in place for the first plan that
lands. Don't add the `-plan` suffix per the naming convention.
.agents/rules/docs-governance.md + .cursor/rules/docs-governance.mdc (new)
- alwaysApply rule pointing at docs/README.md as canonical source.
- Carries the 9-rule quick checklist + the existence test + top-level
cap so agents see them at session start without reading the full
docs/README.md every time.
- Symlinked into .cursor/rules/ per the agents-first-convention rule.
No source code touched; 185/185 tests still pass; goldens all green.1 parent 81ee46a commit b4c3360
5 files changed
Lines changed: 577 additions & 17 deletions
File tree
- .agents/rules
- .cursor/rules
- docs
- plans
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
0 commit comments