MyGO/mygo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: restructure server and web documentation into ADR files and a

Browse Source 
routing table
This commit is contained in:
Sunday
2026-07-17 22:07:55 +08:00
parent f8494a44ca
commit 519aa35f1f
23 changed files with 710 additions and 654 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+19 -12
View File
@@ -1,19 +1,26 @@
# Docs
# Documentation
Documentation is organized by project. Use `server/` for the Go backend and `web/` for the browser client.
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
| File | Content |
|------|---------|
| `server/architecture.md` | Module layout, package boundaries |
| `server/decisions.md` | Technical decisions (ADR) |
| `server/roadmap.md` | Feature progress and status |
| `server/development.md` | Build, test, debug workflow |
| 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
| File | Content |
|------|---------|
| `web/decisions.md` | Technical decisions (ADR) |
| `web/roadmap.md` | Product boundary, foundation, planned structure, and deferred dependencies |
| 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 |