docs: user and developer documentation apart, stale and finished pages dropped #47

Merged
dawid merged 1 commit from debloat into main 2026-11-18 06:40:22 +00:00
Owner

Stacked on #46 (merge that first; this PR's base then shows only its own commit).

Documentation for people using the app is now apart from the developers', and pages that were finished or stale are gone.

docs/user/: what customers read

  • guide.md (was docs/user-guide.md), now with installing the Android APK.
  • models.md: the 50 models with their pictures (was the table in content.md), without code names; images/models/.

docs/dev/: everything else

  • README.md: architecture (now with the control channel and relay), repository layout, page index, decisions, development commands. Replaces docs/architecture.md, which still said there was no network link, and watch/README.md (a stale file table: "never compiled", only d2mach1).
  • watch.md, content.md, interaction.md, android.md, ci.md, deployment.md, publishing.md, device-tests.md (+ the laptop run), decisions/, store-assets/.

Dropped

  • docs/ux-review.md: a one-off review whose findings were all acted on.
  • docs/model-ideas.md: ideas for replacing placeholders; every marker has a model.
  • deployment.md's "What is left to do" (HomeLab #126, the panel, the first release: all done).

Kept, checked as used: every script in tools/ and viewer/tools/ is referenced by CI, a build or a doc. simulate.sh makes the store's screenshot, which moves from docs/images/ to store-assets/screenshot-d2mach1.png.

Also

  • Statuses: decision 004 built, deployment running, interaction built, watch app runs on the D2 Mach 1.
  • Every path in tools, workflows, sources, tests and .gitattributes follows the move. The content test now checks docs/user/models.md by ID and picture, and render-models.mjs writes to docs/user/images/models/.
  • README: shorter "How it works", plus a Documentation section pointing to the two sets.

Checks: markdownlint (all files), ESLint, every generator's --check, the 52 tests that need no browser; CI runs the rest.

Stacked on #46 (merge that first; this PR's base then shows only its own commit). Documentation for people using the app is now apart from the developers', and pages that were finished or stale are gone. **`docs/user/`**: what customers read - `guide.md` (was `docs/user-guide.md`), now with installing the Android APK. - `models.md`: the 50 models with their pictures (was the table in `content.md`), without code names; `images/models/`. **`docs/dev/`**: everything else - `README.md`: architecture (now with the control channel and relay), repository layout, page index, decisions, development commands. Replaces `docs/architecture.md`, which still said there was no network link, and `watch/README.md` (a stale file table: "never compiled", only `d2mach1`). - `watch.md`, `content.md`, `interaction.md`, `android.md`, `ci.md`, `deployment.md`, `publishing.md`, `device-tests.md` (+ the laptop run), `decisions/`, `store-assets/`. **Dropped** - `docs/ux-review.md`: a one-off review whose findings were all acted on. - `docs/model-ideas.md`: ideas for replacing placeholders; every marker has a model. - `deployment.md`'s "What is left to do" (HomeLab #126, the panel, the first release: all done). **Kept, checked as used:** every script in `tools/` and `viewer/tools/` is referenced by CI, a build or a doc. `simulate.sh` makes the store's screenshot, which moves from `docs/images/` to `store-assets/screenshot-d2mach1.png`. **Also** - Statuses: decision 004 built, deployment running, interaction built, watch app runs on the D2 Mach 1. - Every path in tools, workflows, sources, tests and `.gitattributes` follows the move. The content test now checks `docs/user/models.md` by ID and picture, and `render-models.mjs` writes to `docs/user/images/models/`. - README: shorter "How it works", plus a Documentation section pointing to the two sets. Checks: markdownlint (all files), ESLint, every generator's `--check`, the 52 tests that need no browser; CI runs the rest.
feat(watch): the Viewers screen shows the QR code of the viewer's address
All checks were successful
CI / checks (pull_request) Successful in 36s
CI / e2e (pull_request) Successful in 1m44s
CI / relay (pull_request) Successful in 1m32s
CI / image (pull_request) Successful in 56s
CI / android (pull_request) Successful in 2m8s
CI / watch (pull_request) Successful in 2m49s
440ec57266
tools/generate-viewer-qr.mjs writes watch/source/ViewerQr.mc from Link.RELAY's origin with the
qrcode package (a dev dependency of the viewer): upper case in alphanumeric mode, version 2,
25 modules, level M. MarkerView draws it with the marker's layout (now MarkerView.layout) and
two modules of white; CI's checks job fails when it is stale.
feat: the viewer's address set at build time (WRISTMARK_ORIGIN)
All checks were successful
CI / checks (pull_request) Successful in 36s
CI / e2e (pull_request) Successful in 1m46s
CI / relay (pull_request) Successful in 1m30s
CI / image (pull_request) Successful in 56s
CI / android (pull_request) Successful in 2m5s
CI / watch (pull_request) Successful in 2m48s
bbd701079b
watch/source/ViewerAddress.mc (was ViewerQr.mc) holds the origin, the relay Link calls and the
QR code, written by tools/generate-viewer-address.mjs for WRISTMARK_ORIGIN or the default.
tools/build-watch.sh writes it for a set origin and puts the committed file back;
tools/build-app-web.sh points the Android app's relay at it; the release takes the
repository variable WRISTMARK_ORIGIN.
docs: user and developer documentation apart, stale and finished pages dropped
All checks were successful
CI / e2e (pull_request) Successful in 3m54s
CI / relay (pull_request) Successful in 1m35s
CI / android (pull_request) Successful in 5m13s
CI / checks (pull_request) Successful in 35s
CI / image (pull_request) Successful in 58s
CI / watch (pull_request) Successful in 2m55s
98360c4890
docs/user/ (the user guide, and the models' catalog with their pictures, split from
content.md) and docs/dev/ (everything else, with a README of the architecture, layout and
pages in place of the stale architecture.md and watch/README.md). Dropped: ux-review.md
(its findings done) and model-ideas.md (every marker has a model). The simulator's
screenshot moves to the store assets it serves. Paths in tools, workflows, sources and
tests follow; stale statuses updated (deployment running, 004 built).
dawid merged commit ad6e8ca0e7 into main 2026-11-18 06:40:22 +00:00
dawid deleted branch debloat 2026-11-18 06:40:22 +00:00
Sign in to join this conversation.
No description provided.