LostSynapse/box-legend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Restructure README and move test documentation to dev/ #2

Merged
sysop merged 1 commit from claude/readme-restructure into main 2026-09-14 13:57:30 +00:00
Conversation 0 Commits 1 Files changed 3 +474 -610
sysop commented 2026-09-14 11:50:11 +00:00
Owner
Copy link

README had grown to 857 lines, 390 of them a single unsectioned Features list of 28 flat bullets. Modes — the thing that explains the three-way split — was bullet 26, roughly 240 lines below the Receiving-specific features that silently assume it. Snapshot and Checkout got one bullet each.

Structure

Features is split into Shared across modes, Receiving, Snapshot and Checkout, with Modes opening the section. A table of contents is added. Test documentation moves to dev/tests.md.

Corrections

Problem Fix
3 spec paths + a glob in the opening paragraph omitted shipped/; the glob used a delta-N form matching no file Spec references removed, not repaired — internal development record
Test count read 645 Actual is 741
"All four databases", twice Registry holds seven
EPHEMERA_DB_PATH missing from a table headed "every variable the app reads, in one place" Added; it is compose-settable exactly like the six listed beside it
3 commands carried Windows venv paths .venv/bin/
Architecture described two modes and a Receiving/Snapshot switcher Corrected to three
Opening paragraph claimed the modes "share the UPC catalog and nothing else" They also share the settings and account tables, the pinned-field registry and the Active Projects lookup, and Checkout reads a Receiving box's contents via box_log/box_archive for its box import

CLAUDE.md's matching architecture fact drops the word "standalone" for the same reason. That the modes are not pieces of an integrated inventory-tracking system is unchanged and still correct — the authoritative record is upstream.

Also

Podman is documented as the deployment target rather than as a substitution for docker. Delta markers, changelog narration inside feature descriptions, and roadmap speculation are cut throughout. The QR code on printed labels and Checkout's Import Box were undocumented and are now described. The 70-line single sentence enumerating test coverage becomes a table by test file.

857 lines become 663, plus 59 in dev/tests.md.

🤖 Generated with Claude Code

README had grown to 857 lines, 390 of them a single unsectioned Features list of 28 flat bullets. **Modes** — the thing that explains the three-way split — was bullet 26, roughly 240 lines below the Receiving-specific features that silently assume it. Snapshot and Checkout got one bullet each. ## Structure Features is split into **Shared across modes**, **Receiving**, **Snapshot** and **Checkout**, with Modes opening the section. A table of contents is added. Test documentation moves to `dev/tests.md`. ## Corrections | Problem | Fix | |---|---| | 3 spec paths + a glob in the opening paragraph omitted `shipped/`; the glob used a `delta-N` form matching no file | Spec references removed, not repaired — internal development record | | Test count read 645 | Actual is 741 | | "All four databases", twice | Registry holds seven | | `EPHEMERA_DB_PATH` missing from a table headed "every variable the app reads, in one place" | Added; it is compose-settable exactly like the six listed beside it | | 3 commands carried Windows venv paths | `.venv/bin/` | | Architecture described two modes and a Receiving/Snapshot switcher | Corrected to three | | Opening paragraph claimed the modes "share the UPC catalog and nothing else" | They also share the settings and account tables, the pinned-field registry and the Active Projects lookup, and Checkout reads a Receiving box's contents via `box_log`/`box_archive` for its box import | `CLAUDE.md`'s matching architecture fact drops the word "standalone" for the same reason. That the modes are not pieces of an integrated inventory-tracking system is unchanged and still correct — the authoritative record is upstream. ## Also Podman is documented as the deployment target rather than as a substitution for docker. Delta markers, changelog narration inside feature descriptions, and roadmap speculation are cut throughout. The QR code on printed labels and Checkout's Import Box were undocumented and are now described. The 70-line single sentence enumerating test coverage becomes a table by test file. 857 lines become 663, plus 59 in `dev/tests.md`. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
README had grown to 857 lines with six top-level sections, 390 of them a
single unsectioned Features list of 28 flat bullets. Modes -- the thing
that explains the whole three-way split -- was bullet 26, roughly 240
lines below the Receiving-specific features that silently assume it, so
nothing told a reader that "Features" had meant Receiving all along.
Snapshot and Checkout got one bullet each.

Features is now split into Shared across modes, Receiving, Snapshot and
Checkout, with Modes opening the section. A table of contents is added.

Corrections. The three spec paths and the glob in the opening paragraph
all omitted shipped/, and the glob used a delta-N form matching no file;
spec references are removed rather than repaired, being an internal
development record. The test count read 645 against an actual 741.
"All four databases" appeared twice against a registry of seven.
EPHEMERA_DB_PATH was missing from a table headed "every variable the app
reads, in one place" despite being compose-settable exactly like the six
listed alongside it. Three commands carried Windows venv paths.
Architecture still described two modes and a Receiving/Snapshot
switcher.

The opening paragraph claimed the modes "share the UPC catalog and
nothing else". They also share the settings and account tables, the
pinned-field registry and the Active Projects lookup, and Checkout reads
a Receiving box's contents through box_log and box_archive directly for
its box import. CLAUDE.md's matching architecture fact drops the word
"standalone" for the same reason; that the modes are not pieces of an
integrated inventory-tracking system is unchanged and still correct,
since the authoritative record is upstream.

Podman is documented as the deployment target rather than as a
substitution for docker, with one line noting the image is an ordinary
OCI build. Delta markers, changelog narration inside feature
descriptions, and roadmap speculation are cut throughout. The QR code on
printed labels and Checkout's Import Box were undocumented and are now
described.

Test documentation moves to dev/tests.md, joining the development
process material already there. The 70-line single sentence enumerating
coverage becomes a table by test file; a document reviewed by
text-to-speech cannot carry a sentence that long.

857 lines become 663, plus 59 in dev/tests.md.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
sysop merged commit 264adac9b4 into main 2026-09-14 13:57:30 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
LostSynapse/box-legend!2
No description provided.