Skip to content

Comprehensive docs site at casterlygit.github.io/shed/docs #27

Description

@CasterlyGit

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

  1. Quickstart (5 min) — install, init, see it work
  2. The 6 loops explained — what shed observes and how it learns
  3. Privacy deep-dive — every data flow documented, threat model
  4. Configuration reference — every config key, defaults, when to change
  5. The morning brief — how to use it efficiently, keybindings, customization
  6. Troubleshooting — when injection feels wrong, when proposals feel noisy, when latency spikes
  7. Architecture — for contributors, the file layout and hook chain
  8. 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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions