Skip to content

Comments

Add comprehensive documentation#1

Open
sunapi386 wants to merge 1 commit intomainfrom
docs/expand-documentation
Open

Add comprehensive documentation#1
sunapi386 wants to merge 1 commit intomainfrom
docs/expand-documentation

Conversation

@sunapi386
Copy link

Summary

  • Adds six new documentation files to docs/ covering all major subsystems
  • Matches the style of existing docs (mermaid diagrams, YAML examples, reference tables)
  • No code changes — documentation only

New files

File Description
docs/architecture.md System architecture: Society of Mind, two-lane orchestration, threads, queues, shutdown, context pipeline
docs/audio.md Audio pipeline: VAD, ASR engines (TDT/CTC), TTS engines (GLaDOS/Kokoro), interruption, wake word
docs/emotion.md Emotion system: PAD model, HEXACO traits, state/mood, drift, constitutional bridge
docs/memory.md Memory & compaction: MCP memory server, JSONL storage, compaction agent, search
docs/configuration.md Configuration reference: all options, LLM setup, CLI overrides, voice selection
docs/tui.md TUI: keyboard shortcuts, panels, 20+ commands, themes, modal screens

Test plan

  • Verify mermaid diagrams render correctly on GitHub
  • Verify cross-references between docs resolve
  • Spot-check config options against source code

🤖 Generated with Claude Code

…ory, configuration, and TUI

Expands docs/ with six new files covering the full system:
- architecture.md: Society of Mind, two-lane orchestration, threads, queues, shutdown, context pipeline
- audio.md: VAD, ASR engines, TTS engines, interruption handling, wake word
- emotion.md: PAD model, HEXACO traits, state/mood, drift, constitutional bridge
- memory.md: MCP memory server, JSONL storage, compaction agent, search
- configuration.md: Complete config reference, LLM setup, CLI, voice selection
- tui.md: Keyboard shortcuts, panels, commands, themes, modal screens

Co-Authored-By: Claude Opus 4.5 <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