Enforce bundled user guide convention in AGENTS and USER_GUIDE #66

Merged

ValleyGeek merged 1 commit from 0.1.24/user-guide-convention into main

2026-06-13 00:21:14 +00:00

Grok commented

2026-06-13 00:14:11 +00:00

Member

Summary

Codifies and applies the bundled user guide writing convention: factual feature documentation for end users only—no conversational tone, no dev notes.

AGENTS.md

PR-prep step references the bundled user guide rules.
New Bundled user guide practice: declarative feature listings; exclude implementation internals, performance notes, schema details, and issue/PR references.

USER_GUIDE.md

Removes implementation asides (filmstrip/filter processing, comma-formatting note, BLOB/schema wording, source-repo attribution path).
Expands Duplicates with factual Multi/Single workflow bullets (no performance internals).
Tightens Image Viewer preload wording to declarative user-facing facts.

Notes

Documentation-only change; no VERSION bump.

If PR #65 merges afterward, its USER_GUIDE line should be dropped in favor of this convention (or rebase #65 onto this branch).

## Summary Codifies and applies the bundled user guide writing convention: factual feature documentation for end users only—no conversational tone, no dev notes. ## AGENTS.md - PR-prep step references the bundled user guide rules. - New **Bundled user guide** practice: declarative feature listings; exclude implementation internals, performance notes, schema details, and issue/PR references. ## USER_GUIDE.md - Removes implementation asides (filmstrip/filter processing, comma-formatting note, BLOB/schema wording, source-repo attribution path). - Expands **Duplicates** with factual Multi/Single workflow bullets (no performance internals). - Tightens Image Viewer preload wording to declarative user-facing facts. ## Notes Documentation-only change; no `VERSION` bump. If PR #65 merges afterward, its USER_GUIDE line should be dropped in favor of this convention (or rebase #65 onto this branch).

Grok added 1 commit

2026-06-13 00:14:11 +00:00

docs: enforce bundled user guide convention in AGENTS and USER_GUIDE f87c380c30

Add explicit AGENTS rules that USER_GUIDE.md is end-user factual
documentation only—declarative feature listings without dev notes.
Clean the guide to match: remove implementation asides, expand Duplicates
usage facts, and drop repo-path references from Credits.