Commit f3db8de
committed
docs: rewrite documentation for new users — verify every claim against the code
The docs had drifted from reality in ways that actively mislead new users:
- README: bare :latest/:cli image tags don't exist (manifest unknown);
lpb default mode is the Pi CLI (not VSCodium welcome screen); wrong
mount paths (/workspace/... vs /home/lpb/workspace/...); 'pi login'
CLI subcommand does not exist (/login is a TUI command); 'update'
binary does not exist (pi update --extensions); stale pi upstream
baseline (v0.83.0 → v0.84.2); dead lpb-stack/lpb-stack* repo links;
CI triggers described as main-only (dev + main)
- lpb-cli.md: install claimed sudo + /usr/local/bin (it's ~/.local/bin,
no sudo); LPB_MODE/LPB_TAG env vars do not exist in the code; config
file names wrong; fake 'lpb run'/'lpb exec' subcommands; self-update
described as automatic (it is lpb --update, branch follows the tag);
added the real flags (--web/--shell/--ssh, --dev/--main, aliases,
pi passthrough) and the real image-resolution rules
- env-vars.md: same non-existent vars; .env location fixed (project
workspace, optional); real lpb.conf.env defaults; VISION_MODEL does
not exist
- lpb-config.md: promote description used origin/main+origin/dev for
all repos (forks use lpb/lpb-dev); added the 'local stable ahead'
case
- config-repo.md: pin format was invented (real: packages array with
git:owner/repo@tag strings); directory tree corrected against the
actual config repo; skills list corrected (3 shipped skills, not 1)
- lpb-memory-overview.md: config table did not match the template or
extension defaults; llmModelOverride default is the MAIN session
model (not qwen3.5-9b-FLM); template ships legacy-inject
- lpb-memory-analysis.md: marked as a point-in-time diagnostic
- CONTRIBUTING.md: removed dead repo links; feature branches off the
default branch (dev/lpb-dev), not the stable branch
- new doc/forking.md: extracted the Forking & Repointing guide from the
README (README is the docs-site home; kept it lean for new users)
- .env.example: stale ~/.localpibox/ paths → ~/.lpb-stack/
- entrypoint comments: bare :cli/:web usage examples → :latest-cli/web
- .gitignore: ignore the derived docs/ + site/ build trees1 parent ceee157 commit f3db8de
13 files changed
Lines changed: 561 additions & 531 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
48 | | - | |
| 47 | + | |
| 48 | + | |
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
| |||
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
85 | | - | |
| 85 | + | |
86 | 86 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
26 | | - | |
27 | 25 | | |
28 | 26 | | |
29 | 27 | | |
30 | | - | |
31 | | - | |
| 28 | + | |
| 29 | + | |
32 | 30 | | |
33 | 31 | | |
34 | 32 | | |
| |||
0 commit comments