docs: make SETUP.md more user-friendly
Your AI's guard dog to stop it from going rogue.
Brought to you by:
doberman
Menu
▾
▴
#251 docs: make SETUP.md more user-friendly
closed
nobody
None
2026-08-14
2026-08-05
Anonymous
No
Originally created by: QY-25123
Slice
- Feature / Slice: docs — make SETUP.md skimmable (#249)
What this PR does
- Adds an "At a glance" cheat sheet (3 steps, ~5 min, OS-agnostic install) with a small ASCII flow diagram before the detailed walkthrough.
- Explicitly clarifies the README (30-second Quick Start) vs. SETUP.md (full walkthrough + troubleshooting) split at the top of the doc.
- Moves the "wrong or stale
dobermanon PATH" troubleshooting section out of the happy path and into a collapsible appendix at the bottom. - Breaks the long
doberman hook pre/doberman hook postprose paragraphs into skimmable lead-in + bullet lists, consistent with the rest of the doc. - Renumbers section anchors accordingly; verified no other doc (
README.md) links to the now-moved/renamed anchors break (#claude-code-hooks,#mcp-proxy,#openclaware preserved).
Documentation only — no CLI or runtime behavior changes (non-goal per the issue).
Tests added (run in CI)
- None required — docs-only change, no behavior to test.
Security checklist
- [x] Fails closed on error / uncertainty (N/A — no code changed)
- [x] No secret, full file, or unredacted prompt logged or committed
- [x] Any guardrail/learning change is raise-only (no silent loosening) (N/A — no code changed)
- [x] Every BLOCK/AUTH carries reason codes + a human explanation (N/A — no code changed)
Edge cases covered / Deviations from plan / Risks introduced
- Verified all existing anchor links into SETUP.md from README.md still resolve after the reorg.
- Deliberately did not reference the not-yet-shipped
doberman uninstallcommand (tracked separately in [#250]) to avoid documenting a nonexistent CLI verb.
Closes [#249]
Related
Ticket changed by: QY-25123