Images in the README file #212

Closed
opened 2026-09-08 19:33:51 +00:00 by crueber · 3 comments
Owner

The current images in the README aren't actually current. Just get rid of them for now until we're done with a v1.

Also fix the readme name. It should be README.md not README.MD

The current images in the README aren't actually current. Just get rid of them for now until we're done with a v1. Also fix the readme name. It should be README.md not README.MD
Author
Owner

Fixed by #220 (branch fix/issue-212): screenshot block removed from the README until v1, README.MD renamed back to README.md with references reversed and the uppercase-rule exception documented in AGENTS.md Naming. Verification in the PR description.

Fixed by #220 (branch fix/issue-212): screenshot block removed from the README until v1, README.MD renamed back to README.md with references reversed and the uppercase-rule exception documented in AGENTS.md Naming. Verification in the PR description.
Author
Owner

Review of PR #220 (fix/issue-212, commit f28f570) — verified in scratch worktree /tmp/pr220, main worktree untouched.

PASS — image block removal (README.md:7-11): all three screenshot links (repo-overview.png, code-view.png, setup.png) + the 'Browse repositories, read code, configure everything. Click any screenshot...' caption + the 'as the screenshots above show' clause are gone; surrounding copy flows cleanly (bucket paragraph → '## Inspired by walgit'). Own greps for repo-overview|code-view|setup.png|Click any screenshot|screenshot precedent|looks quite different: only unrelated .code-view CSS class hits (ui.css, Setup.jsx, Wal.jsx, etc.) — correctly left alone, no over-correction.

PASS — rename tracked as git rename: git diff --name-status shows R091 README.MD → README.md (91% similarity), not delete+add.

PASS — reference reversal complete, own case-sensitive greps: 'README.MD' = zero hits repo-wide; 'README.md' = 43 hits, all correct stays or fixes: .dockerignore:10 now matches the real filename (functional on case-sensitive FS), AGENTS.md:3 link fixed, root demo snippets (README.md:26, Landing.jsx:127, 16_packaging.md:496) correctly lowercase, docs/features + docs/go + test-fixture README.md hits are subdirectory readmes / generic filenames that must stay. DESIGN.md untouched. Nit (non-blocking): six prose spots were normalized to bare 'README' (01_overview.md:36, 11_config_cli.md:492, 12_web_ui.md:235,243,528, 16_packaging.md:478, AGENTS.md:64) instead of 'README.md' — consistent and defensible as generic refs, but 'README.md' would be more precise; leaving to author discretion.

PASS — docs/img/*.png rightly left in place (code-view.png, repo-overview.png, setup.png all present); no live refs, harmless until v1.

PASS — AGENTS.md:50 Naming exception accurate: rule (all-uppercase list) + exception (README.md lowercase) + issue ref (#212). Verified root holds exactly AGENTS.md, DESIGN.md, DEVIATIONS.md, README.md, so the uppercase list is complete. Law 12 satisfied: AGENTS + 4 go docs + JSX trace comments updated in the same change.

PASS — doctabs unaffected: web/src/lib/doctabs.js:12 README_RE is /^readme.(md|markdown)$/i (case-insensitive, untouched), test pins at web/test/unit/doctabs.test.js:23,32 cover mixed case; demo-snippet justification retained (Landing.jsx comment keeps '(one asset set, no light variants)').

PASS — no Go/JS logic touched: 9 files (dockerignore, AGENTS, rename, 4 docs, 2 JSX); both JSX hunks are comment-only.

VERIFY — node --test web/test/unit/*.test.js: 423/423 pass; vite build + esbuild SDK bundle green (used symlinked main web/node_modules in scratch only; no browser drive per task scope — noted).

MERGE RECOMMENDATION: ready to merge.

Review of PR #220 (fix/issue-212, commit f28f570) — verified in scratch worktree /tmp/pr220, main worktree untouched. PASS — image block removal (README.md:7-11): all three screenshot links (repo-overview.png, code-view.png, setup.png) + the 'Browse repositories, read code, configure everything. Click any screenshot...' caption + the 'as the screenshots above show' clause are gone; surrounding copy flows cleanly (bucket paragraph → '## Inspired by walgit'). Own greps for repo-overview|code-view|setup\.png|Click any screenshot|screenshot precedent|looks quite different: only unrelated .code-view CSS class hits (ui.css, Setup.jsx, Wal.jsx, etc.) — correctly left alone, no over-correction. PASS — rename tracked as git rename: git diff --name-status shows R091 README.MD → README.md (91% similarity), not delete+add. PASS — reference reversal complete, own case-sensitive greps: 'README\.MD' = zero hits repo-wide; 'README\.md' = 43 hits, all correct stays or fixes: .dockerignore:10 now matches the real filename (functional on case-sensitive FS), AGENTS.md:3 link fixed, root demo snippets (README.md:26, Landing.jsx:127, 16_packaging.md:496) correctly lowercase, docs/features + docs/go + test-fixture README.md hits are subdirectory readmes / generic filenames that must stay. DESIGN.md untouched. Nit (non-blocking): six prose spots were normalized to bare 'README' (01_overview.md:36, 11_config_cli.md:492, 12_web_ui.md:235,243,528, 16_packaging.md:478, AGENTS.md:64) instead of 'README.md' — consistent and defensible as generic refs, but 'README.md' would be more precise; leaving to author discretion. PASS — docs/img/*.png rightly left in place (code-view.png, repo-overview.png, setup.png all present); no live refs, harmless until v1. PASS — AGENTS.md:50 Naming exception accurate: rule (all-uppercase list) + exception (README.md lowercase) + issue ref (#212). Verified root holds exactly AGENTS.md, DESIGN.md, DEVIATIONS.md, README.md, so the uppercase list is complete. Law 12 satisfied: AGENTS + 4 go docs + JSX trace comments updated in the same change. PASS — doctabs unaffected: web/src/lib/doctabs.js:12 README_RE is /^readme\.(md|markdown)$/i (case-insensitive, untouched), test pins at web/test/unit/doctabs.test.js:23,32 cover mixed case; demo-snippet justification retained (Landing.jsx comment keeps '(one asset set, no light variants)'). PASS — no Go/JS logic touched: 9 files (dockerignore, AGENTS, rename, 4 docs, 2 JSX); both JSX hunks are comment-only. VERIFY — node --test web/test/unit/*.test.js: 423/423 pass; vite build + esbuild SDK bundle green (used symlinked main web/node_modules in scratch only; no browser drive per task scope — noted). MERGE RECOMMENDATION: ready to merge.
Author
Owner

Fixed by PR #220 (review clean; pure rename, refs reversed, pins green; 423/423), merged. Closing.

Fixed by PR #220 (review clean; pure rename, refs reversed, pins green; 423/423), merged. Closing.
crueber added this to the v1 milestone 2026-09-10 22:27:12 +00:00
Sign in to join this conversation.
No milestone
No project
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
crueber/walhub#212
No description provided.