Skip to content

docs: comprehensive documentation overhaul - #96

Merged
aterrylu merged 1 commit into
mainfrom
terry/docs-update-v3
Mar 29, 2026
Merged

docs: comprehensive documentation overhaul#96
aterrylu merged 1 commit into
mainfrom
terry/docs-update-v3

Conversation

@aterrylu

Copy link
Copy Markdown
Owner

Summary

Full documentation update after ~40 PRs of feature development. README, CLAUDE.md, and AGENTS.md were significantly out of date.

Changes

README.md — rewrote from scratch:

  • Project description: "orchestrator agent" → "mission control platform for autonomous agents"
  • Added all shipped features: split panes, agent status, auto-trust, hook relay, gateway, notifications, PWA
  • Added ASCII architecture diagram
  • Updated structure tree with all server subsystems and dashboard layout module
  • Updated tech stack (added framer-motion, react-resizable-panels)
  • Added FEATURES.md and VISION.md to docs section

CLAUDE.md — major updates:

  • Added FEATURES.md to "Start Here" reading list
  • Separated "current state" vs "future vision" in Project Vision
  • Removed stale philosophy ("observe first", "build on OpenClaw")
  • Added "Key Systems" section documenting hook relay, session flags, auto-trust, gateway, MCP tools, base context injection
  • Added perf: commit prefix

AGENTS.md — synced to match CLAUDE.md

🤖 Generated with Claude Code

README.md:
- Rewrote project description from aspirational orchestrator to actual
  current state (terminal dashboard + agent management)
- Added all shipped features: split panes, agent status, auto-trust,
  hook relay, gateway, notifications, PWA
- Added architecture diagram
- Updated structure tree with all subdirectories
- Updated tech stack with framer-motion, react-resizable-panels
- Added FEATURES.md and VISION.md to docs links

CLAUDE.md:
- Added FEATURES.md to Start Here reading list
- Separated current state vs future vision in Project Vision
- Removed stale "observe first" and "build on OpenClaw" philosophy
- Added Key Systems section: hook relay, session flags, auto-trust
- Added perf: commit prefix
- Synced AGENTS.md to match

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@aterrylu
aterrylu merged commit 51dd466 into main Mar 29, 2026
1 check passed
@aterrylu
aterrylu deleted the terry/docs-update-v3 branch March 29, 2026 05:37
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