docs: Align product documentation with the shipped application (0.4.3) #159

Merged
ValleyGeek merged 3 commits from 0.4.2/docs-product-alignment into main 2026-08-13 02:35:31 +00:00
Member

Summary

Aligns the in-app user guide and supporting product docs with what the application actually does, and bumps VERSION to 0.4.3 because the bundled Help guide (resources/help/USER_GUIDE.md) is a compiled input.

  • User guide — full interaction reference for every workbench, toolbar, dialog, gesture, and default shortcut
  • README — overview only; drops stale claims (AND/OR tag filter, viewer fill/1:1, Keep Best as the current Keep UI)
  • TECHNICAL_OUTLINE / DESIGN / CLAUDE — spec and architecture match shipped behavior (search, AoT, Export/Delete All/Unused tags, Dupe Grid, Keep criteria, multi-tag sort, full-resolution viewer)
  • Status lines no longer pin a release version that would need bumping every ship

compiled-inputs-changed.sh origin/main exits 0 (bundled guide). Decision records are left as historical records.

Test plan

  • ./scripts/check-version-bump.sh — VERSION 0.4.20.4.3
  • python3 scripts/get-version.py --canonical after pip install -e .0.4.3
  • Open Help in the app and spot-check Contents links plus Grid / Tags / Viewer / Duplicates / Trash / Settings
## Summary Aligns the in-app user guide and supporting product docs with what the application actually does, and bumps `VERSION` to **0.4.3** because the bundled Help guide (`resources/help/USER_GUIDE.md`) is a compiled input. - **User guide** — full interaction reference for every workbench, toolbar, dialog, gesture, and default shortcut - **README** — overview only; drops stale claims (AND/OR tag filter, viewer fill/1:1, Keep Best as the current Keep UI) - **TECHNICAL_OUTLINE / DESIGN / CLAUDE** — spec and architecture match shipped behavior (search, AoT, Export/Delete All/Unused tags, Dupe Grid, Keep criteria, multi-tag sort, full-resolution viewer) - Status lines no longer pin a release version that would need bumping every ship `compiled-inputs-changed.sh origin/main` exits 0 (bundled guide). Decision records are left as historical records. ## Test plan - [x] `./scripts/check-version-bump.sh` — VERSION `0.4.2` → `0.4.3` - [x] `python3 scripts/get-version.py --canonical` after `pip install -e .` — `0.4.3` - [ ] Open Help in the app and spot-check Contents links plus Grid / Tags / Viewer / Duplicates / Trash / Settings
Replace the incomplete Help guide with a full interaction reference for
every workbench, toolbar, dialog, and default shortcut. Drop stale
claims that are not in the UI and document controls that were missing
from the previous guide.
Update README, TECHNICAL_OUTLINE, and DESIGN to match current behavior:
OR-only tag filter, Keep with criteria, full-resolution viewer, search,
Advance on Tag, multi-tag sort, and related workbench features. Remove
release-version status lines that would need bumping every ship.
docs: PR-prep for 0.4.3 documentation alignment
All checks were successful
CI / lint (push) Successful in 15s
CI / test (push) Successful in 3m9s
CI / appimage (push) Successful in 21m21s
CI / build-appimage (push) Successful in 0s
CI / windows-exe (push) Successful in 27m21s
CI / build-windows-exe (push) Successful in 0s
41bee382b3
Replace the development VERSION with 0.4.3 and add a dated changelog
section. The bundled user guide is a compiled input, so this release
ships updated Help content with the rest of the product docs.
ValleyGeek deleted branch 0.4.2/docs-product-alignment 2026-08-13 02:35:31 +00:00
Sign in to join this conversation.
No reviewers
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
ai-collab/bulk-image-organizer!159
No description provided.