roof/pic
1
0
Fork 0
Code Issues Pull Requests Actions Wiki Activity

fix: correct the list of former repo doc files in ADR – 004

Dmitrii Iurco
2026-06-11 15:36:13 -04:00
parent af809e1583
commit 3511fc1bee
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ADR – 004 The Wiki Is the Single Documentation Source.md
+2 -2
@@ -8,9 +8,9 @@ As PIC grew, documentation accumulated in multiple places:
- `QUICKSTART.md` — install guide in the repo root - `QUICKSTART.md` — install guide in the repo root
- `Personal Internet Cell – Project Wiki.md` — a monolithic ~5,000-word markdown file in the repo - `Personal Internet Cell – Project Wiki.md` — a monolithic ~5,000-word markdown file in the repo
- `docs/` directory — several topic-specific markdown files - `api/API_DOCUMENTATION.md` — a 1,285-line endpoint reference that still described localhost-only auth and DHCP
- `docs/service-developer-guide.md` — the service manifest reference
- `webui/README.md` — frontend notes for developers - `webui/README.md` — frontend notes for developers
- `Dev-API.md` / `Dev-Architecture.md` — developer docs checked into the repo
These sources drifted rapidly from reality. Because they lived in the git repo, updating them required a code review and merge. Docs for last month's code frequently shipped alongside this month's features. Users reading the README on the repository landing page followed instructions that no longer applied. These sources drifted rapidly from reality. Because they lived in the git repo, updating them required a code review and merge. Docs for last month's code frequently shipped alongside this month's features. Users reading the README on the repository landing page followed instructions that no longer applied.