Skip to content

Commit 8d4f40c

Browse files
author
DavidQ
committed
chore: enforce docs path rules + roadmap location guard & chore: enforce docs path rules + roadmap location guard
1 parent 71c6f48 commit 8d4f40c

File tree

6 files changed

+127
-30
lines changed

6 files changed

+127
-30
lines changed

docs/dev.zip

92 KB
Binary file not shown.

docs/dev/README.md

Lines changed: 38 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,48 @@
1-
Toolbox Aid
2-
David Quesenberry
3-
04/05/2026
4-
README.md
5-
61
# Active Dev Surface
72

83
`docs/dev/` is the active execution surface only.
94

10-
## Active Files
5+
## Required Path Rules
6+
7+
### Roadmaps
8+
All active roadmap files MUST live in:
9+
- `docs/dev/roadmaps/`
10+
11+
The current master roadmap path is:
12+
- `docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md`
13+
14+
Never use:
15+
- `docs/roadmaps/`
16+
- `docs/dev/BIG_PICTURE_ROADMAP.md` for the active master roadmap
17+
- any other duplicate roadmap location
18+
19+
### Active Dev Files
20+
These may live directly under `docs/dev/` only when they are active operating files:
1121
- `README.md`
12-
- `RULES_OF_ENGAGEMENT.md` (single source of truth)
13-
- `codex_commands.md` (must remain header-free)
14-
- `commit_comment.txt` (must remain header-free)
22+
- `paths.md`
23+
- `PLANNING_SYSTEM_RULES.md`
24+
- `ROADMAP_GUARDRAILS.md`
25+
- `CODEX_COMMANDS.md`
26+
- `COMMIT_COMMENT.txt`
1527
- `next_command.txt`
16-
- `reports/change_summary.txt`
17-
- `reports/file_tree.txt`
18-
- `reports/validation_checklist.txt`
1928

20-
## Archive Locations
21-
- Archived operational notes: `docs/archive/dev-ops/`
22-
- Archived generated reports: `docs/archive/generated-reports/`
29+
### Reports
30+
Generated reports must live in:
31+
- `docs/dev/reports/`
32+
33+
### PR Docs
34+
PR docs must live in:
35+
- `docs/pr/`
36+
37+
### Archive
38+
Archived/generated/historical material should live in:
39+
- `docs/archive/dev-ops/`
40+
- `docs/archive/generated-reports/`
41+
- `docs/archive/pr/legacy-pr-history/`
2342

2443
## Rules
2544
- Keep `docs/dev/` minimal and current.
26-
- Do not store stale generated bundles or duplicate operating notes in `docs/dev/`.
27-
- Preserve `docs/pr/` as historical record.
45+
- Keep active roadmap files only in `docs/dev/roadmaps/`.
46+
- Do not create `docs/roadmaps/`.
47+
- Do not leave transitional roadmap files duplicated in `docs/dev/`.
48+
- Preserve `docs/pr/` as historical PR record.

docs/dev/ROADMAP_GUARDRAILS.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,40 @@
1-
# 🛡️ Roadmap Guardrails
1+
# Roadmap Guardrails
22

33
## Purpose
4-
Prevent accidental corruption of BIG_PICTURE_ROADMAP.md by enforcing strict update rules.
4+
Prevent accidental corruption or path drift of the active master roadmap.
55

6-
## RULE: TRACKER FILE PROTECTION
7-
The file `docs/dev/BIG_PICTURE_ROADMAP.md` is a status tracker only.
6+
## TRACKER FILE PROTECTION
7+
The active master roadmap file is:
8+
9+
`docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md`
810

911
### Allowed Changes
10-
- Change ONLY:
11-
- [ ][.][x]
12+
- Change ONLY bracket states:
13+
- `[ ]``[.]``[x]`
1214

1315
### Forbidden Changes
1416
- Adding/removing sections
1517
- Rewriting text
1618
- Reordering items
1719
- Renaming tracks
1820
- Collapsing or expanding content
21+
- Moving the active master roadmap out of `docs/dev/roadmaps/`
22+
- Creating duplicate active roadmap copies elsewhere
23+
24+
## PATH RULE
25+
All active roadmap files MUST live in:
26+
- `docs/dev/roadmaps/`
27+
28+
Never use:
29+
- `docs/roadmaps/`
30+
- `docs/dev/BIG_PICTURE_ROADMAP.md` as the active master roadmap
1931

20-
## VALIDATION CHECK
21-
Any change to BIG_PICTURE_ROADMAP.md must pass:
22-
- Headings unchanged
23-
- No text modified outside brackets
24-
- Only bracket states updated
32+
## Validation Check
33+
Any change to the active master roadmap must pass:
34+
- headings unchanged
35+
- no text modified outside brackets
36+
- only bracket states updated
37+
- file path remains under `docs/dev/roadmaps/`
2538

26-
## CODEX RULE
27-
Codex must treat this file as immutable structure and perform surgical edits only.
39+
## Codex Rule
40+
Codex must treat the active roadmap as immutable structure and perform surgical edits only.

docs/dev/paths.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Repo Path Contracts
2+
3+
## Active Paths
4+
- ROADMAP_PATH = `docs/dev/roadmaps/`
5+
- MASTER_ROADMAP = `docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md`
6+
- PR_PATH = `docs/pr/`
7+
- REPORTS_PATH = `docs/dev/reports/`
8+
9+
## Archive Paths
10+
- DEV_OPS_ARCHIVE = `docs/archive/dev-ops/`
11+
- GENERATED_REPORTS_ARCHIVE = `docs/archive/generated-reports/`
12+
- PR_HISTORY_ARCHIVE = `docs/archive/pr/legacy-pr-history/`
13+
14+
## Strict Rules
15+
1. Active roadmap files MUST live in `docs/dev/roadmaps/`.
16+
2. Never create or use `docs/roadmaps/`.
17+
3. Transitional roadmap files in `docs/dev/` must be moved into `docs/dev/roadmaps/` or archived.
18+
4. Reports belong in `docs/dev/reports/`.
19+
5. PR history belongs in `docs/pr/` or `docs/archive/pr/legacy-pr-history/`.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
DOCS PATH CLEANUP PLAN
2+
3+
KEEP WHERE IT IS
4+
- docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md
5+
- docs/dev/PLANNING_SYSTEM_RULES.md
6+
- docs/dev/CODEX_COMMANDS.md
7+
- docs/dev/COMMIT_COMMENT.txt
8+
- docs/dev/ROADMAP_GUARDRAILS.md
9+
- docs/dev/reports/*
10+
- docs/pr/*
11+
- docs/archive/*
12+
13+
MOVE
14+
- docs/dev/BIG_PICTURE_ROADMAP.md
15+
-> move to docs/dev/roadmaps/BIG_PICTURE_ROADMAP.md if still needed as an active roadmap
16+
-> otherwise archive to docs/archive/dev-ops/ if superseded
17+
18+
- docs/dev/reports/roadmap_move_manifest.txt
19+
-> move to docs/archive/dev-ops/roadmap_move_manifest.txt after the roadmap move is complete
20+
-> it is a transitional operational artifact, not a permanent active report
21+
22+
DELETE
23+
- docs/roadmaps/
24+
-> safe to delete if empty
25+
-> do not recreate
26+
27+
RULES
28+
- active roadmap files live only in docs/dev/roadmaps/
29+
- transitional move manifests should not remain in active reports forever
30+
- no duplicate active roadmap copies in multiple folders

docs/dev/roadmaps/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Roadmaps
2+
3+
This folder is the only valid location for active roadmap files.
4+
5+
## Active Master Roadmap
6+
- `MASTER_ROADMAP_HIGH_LEVEL.md`
7+
8+
## Rule
9+
Do not place active roadmap files in:
10+
- `docs/roadmaps/`
11+
- `docs/dev/`
12+
13+
Use this folder only:
14+
- `docs/dev/roadmaps/`

0 commit comments

Comments
 (0)