Commit 6bcc6ec
docs: align user docs and repo docs with implementation (#7)
Reviewed all user-facing docs (src/docs/) and repo-level docs against
the actual code and fixed inaccuracies surfaced by the audit:
- README.md: fix CI badge URL (deploy.yml → ci.yml); replace tag-based
"Deployment" section with the actual push-to-main flow; list all 5
D1 tables instead of 2.
- RELEASE.md: delete (described a tag-based release process that does
not exist; push-to-main auto-deploys per ci.yml).
- CLAUDE.md: add missing scripts (lint, validate, install:hooks); fix
table count (4 → 5, add config_revisions); correct packages
enrichment description; cross-link AGENTS.md + docs/HARNESS.md.
- src/docs/api-reference.md: rewrite to match the actual handlers —
every endpoint shape (request/response/status), correct rate limits
(CONFIG_READ/WRITE/SEARCH all 30/min), remove fabricated
X-RateLimit-* headers, split dashboard /api/configs/:slug from CLI
/:username/:slug/config, fix install endpoint Content-Type.
- src/docs/config-options.md: document validation limits — custom_script
10K, dotfiles_repo HTTPS + 500, alias 2-20 chars + reserved words,
packages 500/200; fix base_preset default; document
snapshot.macos_prefs[].host.
- src/docs/personal.md: remove false "Dotfiles cloned and linked" line
from the first install transcript (no dotfiles_repo configured yet).
- src/docs/teams.md: correct visibility guidance — private is
owner-only (403 for other users), teams should use unlisted.
- src/docs/snapshot.md: "Before installing" → "Before applying" in the
restore section.
- src/docs/what-is-openboot.md: spaced em-dash for style consistency.
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 1cbe170 commit 6bcc6ec
9 files changed
Lines changed: 218 additions & 265 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
| 18 | + | |
17 | 19 | | |
18 | 20 | | |
19 | 21 | | |
20 | 22 | | |
| 23 | + | |
21 | 24 | | |
22 | 25 | | |
23 | 26 | | |
24 | 27 | | |
25 | 28 | | |
26 | 29 | | |
| 30 | + | |
| 31 | + | |
27 | 32 | | |
28 | 33 | | |
29 | 34 | | |
| |||
57 | 62 | | |
58 | 63 | | |
59 | 64 | | |
60 | | - | |
| 65 | + | |
61 | 66 | | |
62 | 67 | | |
63 | 68 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
48 | | - | |
49 | | - | |
50 | | - | |
51 | | - | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
| 44 | + | |
59 | 45 | | |
60 | 46 | | |
61 | 47 | | |
| |||
82 | 68 | | |
83 | 69 | | |
84 | 70 | | |
85 | | - | |
| 71 | + | |
86 | 72 | | |
87 | 73 | | |
88 | 74 | | |
| |||
This file was deleted.
0 commit comments