|
| 1 | +# Docs Bucket Rules |
| 2 | + |
| 3 | +These rules are strict, precedence-ordered, and non-overlapping by first-match assignment. |
| 4 | + |
| 5 | +## Rule Order (Highest Precedence First) |
| 6 | + |
| 7 | +1. `START_OF_DAY_PROTECTED` |
| 8 | + Basis: Protected start_of_day operational context and instructions. |
| 9 | +2. `ROADMAPS` |
| 10 | + Basis: Master and auxiliary roadmap trackers. |
| 11 | +3. `EXECUTION_REPORTS` |
| 12 | + Basis: Execution/validation/change reports and run outputs. |
| 13 | +4. `PR_BUILD_TRACKING` |
| 14 | + Basis: PLAN/BUILD/APPLY definitions, templates, and PR tracking artifacts. |
| 15 | +5. `RELEASE_ADOPTION` |
| 16 | + Basis: Release-facing onboarding, tours, and adoption docs. |
| 17 | +6. `GAME_DESIGN` |
| 18 | + Basis: Game design documentation and design-era notes. |
| 19 | +7. `ARCHIVE_HISTORICAL` |
| 20 | + Basis: Historical/legacy archived documentation retained for traceability. |
| 21 | +8. `ARCHITECTURE_AND_STANDARDS` |
| 22 | + Basis: Architecture, standards, technical specs, and decisions. |
| 23 | +9. `DEV_OPERATIONS` |
| 24 | + Basis: Developer operations docs not in roadmap/report/start_of_day buckets. |
| 25 | +10. `ROOT_REFERENCE` |
| 26 | + Basis: Top-level reference/entry docs in docs root. |
| 27 | +11. `OTHER_DOCS` |
| 28 | + Basis: Remaining docs paths requiring explicit future placement. |
| 29 | + |
| 30 | +## Pattern Definitions |
| 31 | + |
| 32 | +- `START_OF_DAY_PROTECTED`: `docs/dev/start_of_day/**` |
| 33 | +- `ROADMAPS`: `docs/dev/roadmaps/**` |
| 34 | +- `EXECUTION_REPORTS`: `docs/dev/reports/**` |
| 35 | +- `PR_BUILD_TRACKING`: `docs/pr/**` |
| 36 | +- `RELEASE_ADOPTION`: `docs/release/**` |
| 37 | +- `GAME_DESIGN`: `docs/gdd/**` |
| 38 | +- `ARCHIVE_HISTORICAL`: `docs/archive/**` |
| 39 | +- `ARCHITECTURE_AND_STANDARDS`: `docs/architecture/**`, `docs/specs/**`, `docs/standards/**`, `docs/decisions/**` |
| 40 | +- `DEV_OPERATIONS`: `docs/dev/**` excluding earlier `docs/dev/*` buckets |
| 41 | +- `ROOT_REFERENCE`: markdown files directly under `docs/` |
| 42 | +- `OTHER_DOCS`: any remaining `docs/**` path |
| 43 | + |
| 44 | +## Non-Overlap Guarantee |
| 45 | + |
| 46 | +- Each file is assigned by first matching rule only. |
| 47 | +- No file receives multiple buckets. |
| 48 | +- Unmatched files are forced into `OTHER_DOCS` and must be resolved in follow-up cleanup PRs. |
0 commit comments