Skip to content

docs: rework README and remove planning artifacts - #53

Merged
jkyberneees merged 2 commits into
mainfrom
chore/docs-rework
Aug 31, 2026
Merged

docs: rework README and remove planning artifacts#53
jkyberneees merged 2 commits into
mainfrom
chore/docs-rework

Conversation

@jkyberneees

Copy link
Copy Markdown
Contributor

Summary

Docs-only release train (no code behaviour changes).

  • Remove planning artifactsdocs/REDESIGN.md, docs/PLANNING_MODE_UI.md (shipped long ago; design lives in code/comments), and the 1.7 MB bodek-intro-july-2026.mov binary; clean 9 dangling Go comment references.
  • Rework README — quick start up front, table of contents, grouped feature tour (Interface / Agent / Safety / Telemetry / A11y / Connectivity), new Security model and Troubleshooting sections, expanded Development (links AGENTS.md + docs/INTEGRATIONS.md).
  • Add docs/CONFIGURATION.md — front-end settings file, resolution order, env vars.
  • Fix claim drift found in the audit — drawer digit jump is 19 (nine tabs), theme list includes ember-dark, stale drawer/INTEGRATIONS.md comments synced.

Checklist

  • make fmt / make vet
  • make lint — 0 issues
  • go test -race -count=1 ./... — 7/7 packages green
  • Anchors and relative links verified

REDESIGN.md and PLANNING_MODE_UI.md are session-work planning artifacts; the planning-mode UI shipped long ago and its design now lives in the code and comments. Remove both plus the 1.7 MB intro video binary, and drop the dangling PLANNING_MODE_UI.md pointers from the plan-related Go comments.
Restructure the README for its three audiences: quick start up front, a table of contents, a grouped feature tour, and new security-model and troubleshooting sections. Fix claim drift found in the audit (drawer digit jump covers 1-9 across nine tabs; the theme list includes ember-dark), sync the stale INTEGRATIONS.md drawer line and drawer.go comments, and add docs/CONFIGURATION.md documenting the front-end settings file, resolution order, and environment variables.
@jkyberneees
jkyberneees merged commit 44a0e09 into main Aug 31, 2026
10 of 11 checks passed
@jkyberneees
jkyberneees deleted the chore/docs-rework branch August 31, 2026 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant