27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
# Documentation
|
|
|
|
Read the documents required by the current task. Current-state documents, roadmaps, and decision records serve different purposes.
|
|
|
|
## Shared
|
|
|
|
| Document | Purpose | Read when |
|
|
|----------|---------|-----------|
|
|
| [`writing-guide.md`](writing-guide.md) | Documentation roles and writing rules | Writing or reviewing repository documentation |
|
|
|
|
## Server
|
|
|
|
| Document | Purpose | Read when |
|
|
|----------|---------|-----------|
|
|
| [`server/architecture.md`](server/architecture.md) | Current packages, responsibilities, and enforced boundaries | Changing server structure or cross-package behavior |
|
|
| [`server/development.md`](server/development.md) | Build, test, review, and configuration workflow | Developing or debugging the server |
|
|
| [`server/roadmap.md`](server/roadmap.md) | Available, planned, and future capabilities | Planning or completing server features |
|
|
| [`server/decisions.md`](server/decisions.md) | Server ADR index | Making or revisiting a significant server decision |
|
|
|
|
## Web
|
|
|
|
| Document | Purpose | Read when |
|
|
|----------|---------|-----------|
|
|
| [`../web/README.md`](../web/README.md) | Web development and browser workflow | Developing or debugging the Web client |
|
|
| [`web/roadmap.md`](web/roadmap.md) | Available, planned, and future capabilities | Planning or completing Web features |
|
|
| [`web/decisions.md`](web/decisions.md) | Web ADR index | Making or revisiting a significant Web decision |
|