Skip to content

Commit 479ccd3

Browse files
committed
chore: add Stage 5 docs and update project configuration
- Add API contracts, events, errors, schema, and module LLDs - Add navigation links across all documentation - Update CLAUDE.md formatting and structure - Bump version to 1.1.1 - Remove vitepress cache files from git tracking - Update README image path for vitepress-docs
1 parent 2892ba7 commit 479ccd3

57 files changed

Lines changed: 9976 additions & 55135 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ __screenshots__/
55
dist/
66
coverage/
77
*.tgz
8-
docs/.vitepress/cache/
8+
vitepress-docs/.vitepress/cache/
99
.env
1010
*.tar.gz
1111
tmp/

CLAUDE.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
11
# Claude Code Rules (Key Index First)
22

33
## 🔑 Critical Index (Understanding starts here)
4+
45
This index is the **single most important entry point** for understanding the project.
56
Always read these before making decisions or implementing changes:
67

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

1011
Stage 1 docs:
12+
1113
- `docs/01-discovery/01-brief.md`
1214
- `docs/01-discovery/02-requirements.md`
1315
- `docs/01-discovery/03-scope.md`
1416

1517
Stage 2 docs:
18+
1619
- `docs/02-feasibility/01-options.md`
1720

1821
Stage 3 docs:
22+
1923
- `docs/03-architecture/01-hld.md`
2024
- `docs/03-architecture/02-dataflow.md`
2125
- `docs/03-architecture/03-deployment.md`
2226

2327
Stage 4 docs (Architecture Decision Records):
28+
2429
- `docs/04-adr/0001-web-worker-architecture.md` - Worker-based architecture for non-blocking operations
2530
- `docs/04-adr/0002-opfs-persistent-storage.md` - OPFS for persistent file-based storage
2631
- `docs/04-adr/0003-mutex-queue-concurrency.md` - Mutex queue for serialized operations
@@ -32,35 +37,42 @@ Stage 4 docs (Architecture Decision Records):
3237
---
3338

3439
## Output boundary rules (non-negotiable)
40+
3541
- `.claude/` contains inputs for Claude: templates, agents, commands, hooks.
3642
- `docs/` contains ONLY finalized outputs. Never store templates in `docs/`.
3743

3844
Templates live here:
45+
3946
- `.claude/templates/docs/**`
4047

4148
When generating docs:
49+
4250
- Always start from the template in `.claude/templates/docs/**`
4351
- Do not change headings/sections; only fill in content.
4452

4553
---
4654

4755
## Documentation rule (mandatory)
56+
4857
When writing docs, **add Mermaid diagrams (Mermaid UML) whenever they improve clarity**.
4958
Prefer: flowchart, sequence diagram, state diagram.
5059

5160
---
5261

5362
## Stage order
54-
1) Discovery / Problem Framing
55-
2) Feasibility / Options
56-
3) HLD
57-
4) ADR
58-
5) LLD + Contracts
59-
6) Implementation + Verification
60-
(Status tracking is continuous across all stages.)
63+
64+
1. Discovery / Problem Framing
65+
2. Feasibility / Options
66+
3. HLD
67+
4. ADR
68+
5. LLD + Contracts
69+
6. Implementation + Verification
70+
(Status tracking is continuous across all stages.)
6171

6272
### Stage 1 stop condition
73+
6374
Stage 1 ends when all are explicit and confirmed:
75+
6476
- MVP (P0 requirements)
6577
- Success criteria (testable)
6678
- Non-goals
@@ -69,7 +81,9 @@ Stage 1 ends when all are explicit and confirmed:
6981
---
7082

7183
## Global Definition of Done (DoD)
84+
7285
A task is DONE only if:
86+
7387
- Work completed
7488
- Evidence provided (commit/PR/test commands/results)
7589
- Status board updated: `docs/00-control/01-status.md`

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<p align="center">
44
<a href="https://web-sqlite-js.wuchuheng.com" target="_blank">
5-
<img src="docs/public/web-sqlite-js.gif" width="80%" style="border-radius: 10px;" />
5+
<img src="vitepress-docs/public/web-sqlite-js.gif" width="80%" style="border-radius: 10px;" />
66
</a>
77
</p>
88

0 commit comments

Comments
 (0)