Skip to content

Commit 0a7267a

Browse files
author
DavidQ
committed
BUILD_PR_RULES_OF_ENGAGEMENT_STANDARDIZATION
- Standardized rules into single source of truth - Removed duplicate rule files
1 parent 8a39f5a commit 0a7267a

15 files changed

+120
-253
lines changed

docs/archive/dev-ops/RULES.txt

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/archive/dev-ops/WORKFLOW.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/dev/CODEX_COMMANDS.md

Lines changed: 5 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,10 @@
1-
Toolbox Aid
2-
David Quesenberry
3-
04/05/2026
4-
codex_commands.md
5-
61
MODEL: GPT-5.4-codex
72
REASONING: high
83

94
COMMAND:
10-
Create BUILD_PR_DOCS_CLEANUP_AND_STRUCTURE_REORG implementation.
11-
12-
Requirements:
13-
- Clean only documentation and documentation-adjacent artifacts
14-
- Do not modify engine, tools, samples, games, tests, or runtime code
15-
- Keep `docs/pr/` intact as history
16-
- Make `docs/dev/` active-only:
17-
- README.md
18-
- WORKFLOW_RULES.md
19-
- active CODEX_COMMANDS.md
20-
- active COMMIT_COMMENT.txt
21-
- active NEXT_COMMAND.txt
22-
- only currently valuable reports
23-
- Move durable architecture material out of `docs/dev/ARCHITECTURE.txt` into:
24-
`docs/architecture/repo-operating-model.md`
25-
- Consolidate duplicate workflow/rules/start-of-day notes
26-
- Move older or lower-value generated artifacts to:
27-
- `docs/archive/dev-ops/`
28-
- `docs/archive/generated-reports/`
29-
- Delete obvious no-value doc artifacts when safe
30-
- Update key docs:
31-
- README.md
32-
- docs/README.md
33-
- docs/getting-started.md
34-
- docs/architecture/README.md
35-
- docs/architecture/engine-api-boundary.md
36-
- docs/dev/README.md
37-
- docs/repo-directory-structure.md if present
38-
- docs/review-checklist.md if present
39-
- Do not introduce broken links
40-
- Keep `docs/dev/commit_comment.txt` header-free
41-
- Package implementation output to:
42-
<project folder>/tmp/BUILD_PR_DOCS_CLEANUP_AND_STRUCTURE_REORG_delta.zip
5+
Create RULES_OF_ENGAGEMENT.md and remove duplicate rule files.
436

44-
Report back:
45-
- exact docs/files removed
46-
- exact docs/files moved
47-
- exact docs/files updated
48-
- final active docs/dev structure
49-
- final archive structure
7+
- Consolidate RULES.txt and WORKFLOW.md
8+
- Keep single source of truth
9+
- Do not touch runtime code
10+
- Package to <project folder>/tmp/BUILD_PR_RULES_OF_ENGAGEMENT_STANDARDIZATION_delta.zip

docs/dev/COMMIT_COMMENT.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
docs: cleanup docs structure, archive stale dev artifacts, and normalize active dev surface
1+
BUILD_PR_RULES_OF_ENGAGEMENT_STANDARDIZATION
2+
3+
- Standardized rules into single source of truth
4+
- Removed duplicate rule files

docs/dev/NEXT_COMMAND.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
APPLY_PR_DOCS_CLEANUP_AND_STRUCTURE_REORG
1+
APPLY_PR_RULES_OF_ENGAGEMENT_STANDARDIZATION

docs/dev/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ README.md
99

1010
## Active Files
1111
- `README.md`
12-
- `WORKFLOW_RULES.md`
12+
- `RULES_OF_ENGAGEMENT.md` (single source of truth)
1313
- `codex_commands.md` (must remain header-free)
1414
- `commit_comment.txt` (must remain header-free)
1515
- `next_command.txt`

docs/dev/RULES_OF_ENGAGEMENT.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Toolbox Aid
2+
David Quesenberry
3+
04/05/2026
4+
RULES_OF_ENGAGEMENT.md
5+
6+
# Rules Of Engagement
7+
8+
## Single Source Of Truth
9+
This file is the canonical workflow and rules document for active repo operations.
10+
11+
## Required Workflow
12+
`PLAN_PR -> BUILD_PR -> APPLY_PR`
13+
14+
## Core Rules
15+
- Docs-first before implementation.
16+
- One PR per purpose.
17+
- No skipped workflow steps.
18+
- Keep PR scope small and surgical.
19+
- Keep `docs/pr/` intact as history.
20+
- Do not modify runtime code unless explicitly in scope.
21+
22+
## Responsibility Model
23+
- Planning/docs bundle defines scope and acceptance.
24+
- Implementation applies approved scope only.
25+
- Active execution control files are in `docs/dev/`.
26+
27+
## Active Dev Controls
28+
- `docs/dev/codex_commands.md`
29+
- `docs/dev/commit_comment.txt` (header-free)
30+
- `docs/dev/next_command.txt`
31+
- `docs/dev/reports/change_summary.txt`
32+
- `docs/dev/reports/file_tree.txt`
33+
- `docs/dev/reports/validation_checklist.txt`
34+
35+
## Packaging
36+
- Repo-structured delta ZIP outputs go to `<project folder>/tmp/`.

docs/dev/WORKFLOW_RULES.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/dev/reports/change_summary.txt

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@ David Quesenberry
44
change_summary.txt
55

66
Summary
7-
- Reorganized documentation structure with docs-only scope.
8-
- Reduced `docs/dev/` to active workflow controls.
9-
- Retained only active reports in `docs/dev/reports/`.
10-
- Moved duplicate/stale operational notes to `docs/archive/dev-ops/`.
11-
- Moved legacy generated reports to `docs/archive/generated-reports/`.
12-
- Migrated durable operating model content into `docs/architecture/repo-operating-model.md`.
13-
- Updated root/docs architecture and review guide documents to match the new structure.
7+
- Added canonical `docs/dev/RULES_OF_ENGAGEMENT.md` as the single source of truth.
8+
- Consolidated rule/workflow guidance from legacy `RULES.txt` and `WORKFLOW.md`.
9+
- Removed duplicate rule files from active/archive locations.
10+
- Updated active docs references to point at `RULES_OF_ENGAGEMENT.md`.

docs/dev/reports/file_tree.txt

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,13 @@ David Quesenberry
33
04/05/2026
44
file_tree.txt
55

6-
README.md
7-
docs/README.md
8-
docs/getting-started.md
9-
docs/repo-directory-structure.md
10-
docs/review-checklist.md
11-
docs/architecture/README.md
12-
docs/architecture/engine-api-boundary.md
13-
docs/architecture/repo-operating-model.md
6+
docs/dev/RULES_OF_ENGAGEMENT.md
147
docs/dev/README.md
15-
docs/dev/WORKFLOW_RULES.md
16-
docs/dev/reports/README.md
8+
docs/getting-started.md
9+
docs/dev/WORKFLOW_RULES.md (removed)
10+
docs/archive/dev-ops/RULES.txt (removed)
11+
docs/archive/dev-ops/WORKFLOW.md (removed)
12+
docs/dev/start_of_day/RULES_OF_ENGAGEMENT.md (removed)
1713
docs/dev/reports/change_summary.txt
18-
docs/dev/reports/validation_checklist.txt
1914
docs/dev/reports/file_tree.txt
20-
docs/dev/commit_comment.txt
21-
docs/dev/next_command.txt
22-
docs/archive/dev-ops/ARCHITECTURE.txt
23-
docs/archive/dev-ops/DELETE_CANDIDATES.txt
24-
docs/archive/dev-ops/DOC_CLEANUP_AND_UPDATE_AUDIT.md
25-
docs/archive/dev-ops/QC_click_by_click_test_script.md
26-
docs/archive/dev-ops/RULES.txt
27-
docs/archive/dev-ops/UPDATE_REQUIRED.txt
28-
docs/archive/dev-ops/WORKFLOW.md
29-
docs/archive/generated-reports/QC - SPRITE_EDITOR_FINAL_QC.txt
30-
docs/archive/generated-reports/dev-reports/*.txt
15+
docs/dev/reports/validation_checklist.txt

0 commit comments

Comments
 (0)