Skip to content

Commit abfcd19

Browse files
committed
docs(agent): rename docs to agent-docs #2
1 parent 194756a commit abfcd19

23 files changed

Lines changed: 2486 additions & 2280 deletions

CLAUDE.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,50 +5,50 @@
55
This index is the **single most important entry point** for understanding the project.
66
Always read these before making decisions or implementing changes:
77

8-
1. Spec (source of truth): `docs/00-control/00-spec.md`
9-
2. Status board (live progress): `docs/00-control/01-status.md`
8+
1. Spec (source of truth): `agent-docs/00-control/00-spec.md`
9+
2. Status board (live progress): `agent-docs/00-control/01-status.md`
1010

1111
Stage 1 docs:
1212

13-
- `docs/01-discovery/01-brief.md`
14-
- `docs/01-discovery/02-requirements.md`
15-
- `docs/01-discovery/03-scope.md`
13+
- `agent-docs/01-discovery/01-brief.md`
14+
- `agent-docs/01-discovery/02-requirements.md`
15+
- `agent-docs/01-discovery/03-scope.md`
1616

1717
Stage 2 docs:
1818

19-
- `docs/02-feasibility/01-options.md`
19+
- `agent-docs/02-feasibility/01-options.md`
2020

2121
Stage 3 docs:
2222

23-
- `docs/03-architecture/01-hld.md`
24-
- `docs/03-architecture/02-dataflow.md`
25-
- `docs/03-architecture/03-deployment.md`
23+
- `agent-docs/03-architecture/01-hld.md`
24+
- `agent-docs/03-architecture/02-dataflow.md`
25+
- `agent-docs/03-architecture/03-deployment.md`
2626

2727
Stage 4 docs (Architecture Decision Records):
2828

29-
- `docs/04-adr/0001-web-worker-architecture.md` - Worker-based architecture for non-blocking operations
30-
- `docs/04-adr/0002-opfs-persistent-storage.md` - OPFS for persistent file-based storage
31-
- `docs/04-adr/0003-mutex-queue-concurrency.md` - Mutex queue for serialized operations
32-
- `docs/04-adr/0004-release-versioning-system.md` - Release versioning for database migrations
33-
- `docs/04-adr/0005-coop-coep-requirement.md` - COOP/COEP headers for SharedArrayBuffer
34-
- `docs/04-adr/0006-typescript-type-system.md` - TypeScript type system with generic parameters
35-
- `docs/04-adr/0007-error-handling-strategy.md` - Error handling with stack trace preservation
29+
- `agent-docs/04-adr/0001-web-worker-architecture.md` - Worker-based architecture for non-blocking operations
30+
- `agent-docs/04-adr/0002-opfs-persistent-storage.md` - OPFS for persistent file-based storage
31+
- `agent-docs/04-adr/0003-mutex-queue-concurrency.md` - Mutex queue for serialized operations
32+
- `agent-docs/04-adr/0004-release-versioning-system.md` - Release versioning for database migrations
33+
- `agent-docs/04-adr/0005-coop-coep-requirement.md` - COOP/COEP headers for SharedArrayBuffer
34+
- `agent-docs/04-adr/0006-typescript-type-system.md` - TypeScript type system with generic parameters
35+
- `agent-docs/04-adr/0007-error-handling-strategy.md` - Error handling with stack trace preservation
3636

3737
---
3838

3939
## Output boundary rules (non-negotiable)
4040

41-
- `.claude/` contains inputs for Claude: templates, agents, commands, hooks.
42-
- `docs/` contains ONLY finalized outputs. Never store templates in `docs/`.
41+
- `.claude/` contains inputs for Claude: templates, agents, commands, hooks.
42+
- `agent-docs/` contains ONLY finalized outputs. Never store templates in `agent-docs/`.
4343

4444
Templates live here:
4545

46-
- `.claude/templates/docs/**`
46+
- `.claude/templates/agent-docs/**`
4747

4848
When generating docs:
4949

50-
- Always start from the template in `.claude/templates/docs/**`
51-
- Do not change headings/sections; only fill in content.
50+
- Always start from the template in `.claude/templates/agent-docs/**`
51+
- Do not change headings/sections; only fill in content.
5252

5353
---
5454

@@ -73,18 +73,18 @@ Prefer: flowchart, sequence diagram, state diagram.
7373

7474
Stage 1 ends when all are explicit and confirmed:
7575

76-
- MVP (P0 requirements)
77-
- Success criteria (testable)
78-
- Non-goals
79-
- Backlog (future ideas)
76+
- MVP (P0 requirements)
77+
- Success criteria (testable)
78+
- Non-goals
79+
- Backlog (future ideas)
8080

8181
---
8282

8383
## Global Definition of Done (DoD)
8484

8585
A task is DONE only if:
8686

87-
- Work completed
88-
- Evidence provided (commit/PR/test commands/results)
89-
- Status board updated: `docs/00-control/01-status.md`
90-
- Spec index updated if any reading order / stage outputs changed
87+
- Work completed
88+
- Evidence provided (commit/PR/test commands/results)
89+
- Status board updated: `agent-docs/00-control/01-status.md`
90+
- Spec index updated if any reading order / stage outputs changed

agent-docs/00-control/00-spec.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
## Document Structure
7575

7676
```
77-
docs/
77+
agent-docs/
7878
├── 00-control/ # Control and coordination
7979
│ ├── 00-spec.md # This file - specification index
8080
│ └── 01-status.md # Live progress board
@@ -129,10 +129,10 @@ docs/
129129

130130
**Doc Update Checklist**:
131131

132-
- Update `docs/05-design/01-contracts/01-api.md` and `docs/05-design/01-contracts/02-events.md` when public API or worker protocol changes.
133-
- Update `docs/03-architecture/02-dataflow.md` and relevant ADRs for concurrency, release, or storage changes.
134-
- Keep `docs/06-implementation/02-test-plan.md` and module test sections in sync with actual test files.
135-
- Mirror user-facing changes in `vitepress-docs/` (public docs site).
132+
- Update `agent-docs/05-design/01-contracts/01-api.md` and `agent-docs/05-design/01-contracts/02-events.md` when public API or worker protocol changes.
133+
- Update `agent-docs/03-architecture/02-dataflow.md` and relevant ADRs for concurrency, release, or storage changes.
134+
- Keep `agent-docs/06-implementation/02-test-plan.md` and module test sections in sync with actual test files.
135+
- Mirror user-facing changes in `vitepress-agent-docs/` (public docs site).
136136

137137
---
138138

@@ -411,7 +411,7 @@ A task is **DONE** only if:
411411

412412
- ✅ Work completed
413413
- ✅ Evidence provided (commit/PR/test commands/results)
414-
- ✅ Status board updated: [docs/00-control/01-status.md](./01-status.md)
414+
- ✅ Status board updated: [agent-docs/00-control/01-status.md](./01-status.md)
415415
- ✅ This spec index updated if any reading order or stage outputs changed
416416

417417
---
@@ -436,25 +436,25 @@ A task is **DONE** only if:
436436

437437
### Critical Paths
438438

439-
- **MVP Requirements**: [docs/01-discovery/02-requirements.md#1-mvp-p0-requirements](../01-discovery/02-requirements.md#1-mvp-p0-requirements)
440-
- **Success Criteria**: [docs/01-discovery/02-requirements.md#2-success-criteria](../01-discovery/02-requirements.md#2-success-criteria)
441-
- **Non-goals**: [docs/01-discovery/02-requirements.md#3-non-goals-explicitly-out-of-scope](../01-discovery/02-requirements.md#3-non-goals-explicitly-out-of-scope)
442-
- **Glossary**: [docs/01-discovery/03-scope.md#4-glossary](../01-discovery/03-scope.md#4-glossary)
443-
- **Technical Options**: [docs/02-feasibility/01-options.md](../02-feasibility/01-options.md)
444-
- **Risk Register**: [docs/02-feasibility/02-risk-assessment.md](../02-feasibility/02-risk-assessment.md)
445-
- **Spike Plans**: [docs/02-feasibility/03-spike-plan.md](../02-feasibility/03-spike-plan.md)
446-
- **System Architecture**: [docs/03-architecture/01-hld.md](../03-architecture/01-hld.md)
447-
- **Data Flow**: [docs/03-architecture/02-dataflow.md](../03-architecture/02-dataflow.md)
448-
- **Deployment**: [docs/03-architecture/03-deployment.md](../03-architecture/03-deployment.md)
449-
- **Architecture Decisions**: [docs/04-adr/](../04-adr/)
450-
- **API Contracts**: [docs/05-design/01-contracts/01-api.md](../05-design/01-contracts/01-api.md)
451-
- **Database Schema**: [docs/05-design/02-schema/01-database.md](../05-design/02-schema/01-database.md)
452-
- **Build and Run Guide**: [docs/06-implementation/01-build-and-run.md](../06-implementation/01-build-and-run.md)
453-
- **Test Plan**: [docs/06-implementation/02-test-plan.md](../06-implementation/02-test-plan.md)
454-
- **Observability Guide**: [docs/06-implementation/03-observability.md](../06-implementation/03-observability.md)
455-
- **Release and Rollback Guide**: [docs/06-implementation/04-release-and-rollback.md](../06-implementation/04-release-and-rollback.md)
456-
- **Roadmap & Strategy**: [docs/07-taskManager/01-roadmap.md](../07-taskManager/01-roadmap.md)
457-
- **Task Catalog**: [docs/07-taskManager/02-task-catalog.md](../07-taskManager/02-task-catalog.md)
439+
- **MVP Requirements**: [agent-docs/01-discovery/02-requirements.md#1-mvp-p0-requirements](../01-discovery/02-requirements.md#1-mvp-p0-requirements)
440+
- **Success Criteria**: [agent-docs/01-discovery/02-requirements.md#2-success-criteria](../01-discovery/02-requirements.md#2-success-criteria)
441+
- **Non-goals**: [agent-docs/01-discovery/02-requirements.md#3-non-goals-explicitly-out-of-scope](../01-discovery/02-requirements.md#3-non-goals-explicitly-out-of-scope)
442+
- **Glossary**: [agent-docs/01-discovery/03-scope.md#4-glossary](../01-discovery/03-scope.md#4-glossary)
443+
- **Technical Options**: [agent-docs/02-feasibility/01-options.md](../02-feasibility/01-options.md)
444+
- **Risk Register**: [agent-docs/02-feasibility/02-risk-assessment.md](../02-feasibility/02-risk-assessment.md)
445+
- **Spike Plans**: [agent-docs/02-feasibility/03-spike-plan.md](../02-feasibility/03-spike-plan.md)
446+
- **System Architecture**: [agent-docs/03-architecture/01-hld.md](../03-architecture/01-hld.md)
447+
- **Data Flow**: [agent-docs/03-architecture/02-dataflow.md](../03-architecture/02-dataflow.md)
448+
- **Deployment**: [agent-docs/03-architecture/03-deployment.md](../03-architecture/03-deployment.md)
449+
- **Architecture Decisions**: [agent-docs/04-adr/](../04-adr/)
450+
- **API Contracts**: [agent-docs/05-design/01-contracts/01-api.md](../05-design/01-contracts/01-api.md)
451+
- **Database Schema**: [agent-docs/05-design/02-schema/01-database.md](../05-design/02-schema/01-database.md)
452+
- **Build and Run Guide**: [agent-docs/06-implementation/01-build-and-run.md](../06-implementation/01-build-and-run.md)
453+
- **Test Plan**: [agent-docs/06-implementation/02-test-plan.md](../06-implementation/02-test-plan.md)
454+
- **Observability Guide**: [agent-docs/06-implementation/03-observability.md](../06-implementation/03-observability.md)
455+
- **Release and Rollback Guide**: [agent-docs/06-implementation/04-release-and-rollback.md](../06-implementation/04-release-and-rollback.md)
456+
- **Roadmap & Strategy**: [agent-docs/07-taskManager/01-roadmap.md](../07-taskManager/01-roadmap.md)
457+
- **Task Catalog**: [agent-docs/07-taskManager/02-task-catalog.md](../07-taskManager/02-task-catalog.md)
458458

459459
### Architecture Key Points
460460

0 commit comments

Comments
 (0)