Skip to content

Commit f856054

Browse files
mpawliszynclaude
andcommitted
refactor: reorganize docs/ structure for multi-version development
Promote app runtime artifacts (templates/, troubleshoot/) to repo root alongside agents/, commands/, scripts/. Archive hackweek sprint output to docs/hackweek/. Create version-scoped docs/v1/ for active work. Add doc file routing conventions to AGENTS.md and docs/README.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Michael Pawliszyn <mpawliszyn@gmail.com>
1 parent af5fa9a commit f856054

20 files changed

Lines changed: 661 additions & 9 deletions

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Private research and working documents
2+
docs/private/

AGENTS.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,22 @@ scripts/
2525
coverage-report.sh # Coverage summary from tree
2626
check-tree-quality.sh # Structural quality validation
2727
28+
templates/
29+
review-tree.md # Format spec: the tree IS the state
30+
review-comments.md # Format spec: comment store
31+
32+
troubleshoot/
33+
agent-struggling.md # Diagnostic guide loaded on agent failure
34+
2835
tests/
2936
scripts/ # bats-core tests for shell scripts
3037
formats/ # Sample format files for validation
3138
3239
docs/
33-
templates/ # Format templates (review-tree, review-comments, user-hints)
34-
troubleshoot/ # Diagnostic guides loaded only on failure
40+
guides/ # Version-independent development guidance
41+
hackweek/ # Feb 23-26 2026 sprint archive
42+
v1/ # Active V1 work: plans, designs, decision records
43+
private/ # Investigation workbench (scratch and reconstruction work)
3544
```
3645

3746
## Conventions
@@ -81,10 +90,23 @@ Files in this repo are loaded into LLM context windows during operation. Stale r
8190
When adding forward-looking version notes to files, add an entry here so future agents know to clean them up.
8291

8392
**Known examples:**
84-
- `docs/templates/review-comments.md` has a **V1.1 Posting Compatibility** section (~50 lines) with GitHub API mapping, GraphQL recommendations, and graceful degradation strategy. This is forward-looking spec commentary for V1.0. When V1.1 posting is implemented, replace this section with actual implementation docs.
93+
- `templates/review-comments.md` has a **V1.1 Posting Compatibility** section (~50 lines) with GitHub API mapping, GraphQL recommendations, and graceful degradation strategy. This is forward-looking spec commentary for V1.0. When V1.1 posting is implemented, replace this section with actual implementation docs.
8594

8695
### Commits
8796

8897
- One logical change per commit
8998
- Descriptive messages explaining why, not just what
9099
- Every task ends with: verify, document, commit
100+
101+
### Doc File Routing
102+
103+
Working files go to predictable locations based on their type:
104+
105+
- **Workbench files** (scratch, investigation, drafts) go in `docs/private/`
106+
- **Designs, specs, plans, and decision records** go in the current version folder (e.g., `docs/v1/`). Examples: implementation plans, design-decisions docs, reorg specs.
107+
- **Curated research** goes in the current version's `research/` subfolder (e.g., `docs/v1/research/`). Research starts in `docs/private/` and gets promoted when it's high-signal enough to keep.
108+
- **Version-independent guides** stay in `docs/guides/`
109+
110+
The current version is declared in `docs/README.md`.
111+
112+
Tools may try to write specs or plans to their own default locations (e.g., `docs/superpowers/specs/`). Redirect these to the appropriate folder.

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,18 @@ scripts/
132132
coverage-report.sh # Coverage summary from tree
133133
check-tree-quality.sh # Structural quality validation
134134
135+
templates/
136+
review-tree.md # Format spec: the tree IS the state
137+
review-comments.md # Format spec: comment store, V1.1 posting
138+
139+
troubleshoot/
140+
agent-struggling.md # Diagnostic guide loaded on agent failure
141+
135142
docs/
136-
templates/
137-
review-tree.md # Format spec: the tree IS the state
138-
review-comments.md # Format spec: comment store, V1.1 posting
143+
guides/ # Version-independent development guidance
144+
hackweek/ # Feb 23-26 2026 sprint archive
145+
v1/ # Active V1 plans, designs, decision records
146+
private/ # Investigation workbench (gitignored)
139147
140148
tests/
141149
formats/ # Parsing tests for format specs (bats-core)

docs/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Docs
2+
3+
**Current version: V1**
4+
5+
Plans, designs, decision records, and curated research for V1 go in `v1/`.
6+
7+
## Structure
8+
9+
| Directory | Purpose |
10+
|-----------|---------|
11+
| `guides/` | Version-independent development guidance (prompt principles, design guide) |
12+
| `hackweek/` | Archive of the Feb 23-26 2026 sprint that created Fowlcon's foundation |
13+
| `v1/` | Active V1 work: plans, designs, decision records, promoted research |
14+
| `private/` | Investigation workbench: scratch files, drafts, reconstruction work |
15+
16+
Future versions (v1.001/, v1.01/, v1.1/) get their own directories as work begins.
17+
18+
## Where files go
19+
20+
- **Plans, designs, specs, decision records** go directly in the current version folder
21+
- **Research** starts in `private/` and gets promoted to the version's `research/` subfolder when it's high-signal enough to keep
22+
- **Scratch work and investigation** stays in `private/`
23+
24+
See AGENTS.md (repo root) for the full file routing conventions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)