Skip to content

docs: comprehensive documentation rewrite#424

Open
dimakis wants to merge 1 commit into
mainfrom
docs/comprehensive-rewrite
Open

docs: comprehensive documentation rewrite#424
dimakis wants to merge 1 commit into
mainfrom
docs/comprehensive-rewrite

Conversation

@dimakis

@dimakis dimakis commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Summary

  • Rewrites README with accurate module tables, full API summary table, documentation index, updated architecture diagram, and new features (multi-model reasoning, desktop mode, APNs)
  • Creates seven new dedicated documentation files covering all major systems in depth

New Documentation

Document Description
docs/architecture.md Module structure, data flow diagrams, request flow walkthrough, session lifecycle state machine, event store, permission system, observability stack, design decisions
docs/api-reference.md Complete REST API reference -- every endpoint with request/response JSON schemas, query parameters, error codes. Covers auth, sessions, chat (WS + REST), tasks, files, skills, calendar, todos, workload, inbox, signals, push notifications
docs/v2-protocol.md WebSocket streaming protocol guide -- handshake, reconnection with seq replay, session management, full block lifecycle (message_start/block_start/delta/end/tool_result/message_end), deferred message_end, subagent nesting, SSE fallback
docs/skills.md Skills system user guide -- bundled skills table, custom skill authoring with frontmatter format, discovery scopes and precedence, tool restriction ceiling, API reference
docs/task-board.md Task orchestration guide -- task tree hierarchy, status cascade, DFS ordering, spec mode, orchestrator state machine, agent MCP tools, task context injection, workflow templates with gate configs, full REST API
docs/session-isolation.md Worktree isolation guide -- multi-repo setup, write enforcement by client, system prompt injection, external hooks (Claude Code/Cursor), cleanup and dirty worktree handling, session index, troubleshooting
docs/packages.md npm workspace package reference -- full type definitions and API for @mitzo/protocol (message types, schemas, event store), @mitzo/harness (session registry, connection registry, permission handler, model providers, reasoning orchestrators), @mitzo/client (MitzoConnection, Zustand store with 12 slices, protocol parser, API client, React hooks)

Test plan

  • Verify all internal doc links resolve (e.g., docs/v2-protocol.md from README)
  • Verify design doc references in architecture.md and task-board.md are correct
  • Spot-check API endpoint descriptions against actual route implementations
  • Confirm no hardcoded test counts or stale metrics

🤖 Generated with Claude Code

Rewrite README with accurate module table, full API summary, documentation
index, and updated architecture diagram. Create seven new dedicated docs:

- architecture.md: module structure, data flow, session lifecycle, design decisions
- api-reference.md: complete REST API reference with request/response schemas
- v2-protocol.md: WebSocket streaming protocol guide with message lifecycle
- skills.md: skills system user guide with authoring instructions
- task-board.md: task orchestration guide with DFS execution, spec mode, templates
- session-isolation.md: worktree isolation guide with enforcement, cleanup, hooks
- packages.md: npm workspace package reference for protocol, harness, client

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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