What this adds
A real docs site at casterlygit.github.io/shed/docs/ (currently only the demo lives there). Hand-written long-form documentation for users who want to actually understand and configure shed.
Sections
- Quickstart (5 min) — install, init, see it work
- The 6 loops explained — what shed observes and how it learns
- Privacy deep-dive — every data flow documented, threat model
- Configuration reference — every config key, defaults, when to change
- The morning brief — how to use it efficiently, keybindings, customization
- Troubleshooting — when injection feels wrong, when proposals feel noisy, when latency spikes
- Architecture — for contributors, the file layout and hook chain
- Cookbook — common patterns: per-repo configs, custom redactor patterns, manual memory authoring
Implementation
- Static site generated from markdown (Hugo or just plain HTML+CSS+JS, no framework)
- Lives at
docs/site/ in the shed repo
- GitHub Pages serves both the existing
/docs/index.html (demo) and /docs/site/ (docs)
- Cross-linked: README → docs site → demo → back
Acceptance
- Someone who has never used shed can read the docs and successfully install + configure
- Search works (lunr.js or similar)
- Mobile-readable
- Lighthouse score > 95
What this adds
A real docs site at
casterlygit.github.io/shed/docs/(currently only the demo lives there). Hand-written long-form documentation for users who want to actually understand and configure shed.Sections
Implementation
docs/site/in the shed repo/docs/index.html(demo) and/docs/site/(docs)Acceptance