Skip to content

Latest commit

 

History

History
298 lines (228 loc) · 14.8 KB

README.md

File metadata and controls

298 lines (228 loc) · 14.8 KB

JTAG Documentation Index

Comprehensive documentation for the JTAG system and PersonaUser architecture.

📚 Documentation Organization

docs/
├── architecture/         - System architecture and design patterns
│   ├── VISION-MEDIA-ARCHITECTURE.md
│   └── MEDIA-FORMAT-CONVERSION-ARCHITECTURE.md
├── personas/             - PersonaUser, genomic, and fine-tuning architecture
├── papers/               - Research papers on core innovations (RTOS, LoRA genomes)
├── recipes/              - Recipe system for AI learning and collaboration
├── testing/              - Testing strategies, reports, and findings
├── design/               - Design patterns and style guides
│   ├── principles/       - Core design principles
│   │   └── DESIGN-PRINCIPLE-NATURAL-IDIOMS.md
│   └── interfaces/       - Interface design patterns
│       └── CLI-ARRAY-PARAMETERS.md
└── archive/              - Historical docs and session notes

🏛️ Architecture Documentation

Core System Architecture:

Command & Event System:

Data & Entity System:

User System:

UI & Widgets:

Security & Services:

Training & Learning:

Media & Vision:

🧬 PersonaUser & Genomic Architecture

Core Persona Architecture:

Phase 7: LoRA Fine-Tuning:

Academy & Learning (Legacy):

Module-Level Documentation:

See system/user/server/modules/ for the latest autonomous loop and genome paging designs:

📄 Research Papers & Vision

Academic Papers on Core Innovations:

Vision Documents:

Key Topics Covered:

  • RTOS infinite loop patterns for autonomous agents
  • CBAR Mobile-Home-SDK architecture (42fps on iPhone 7 with heavy AR workload)
  • Thought frame parallel processing and worker affinity
  • Economic accessibility of SOTA intelligence via LoRA adapters
  • Mentorship-based training and phenotype trading on Grid
  • Democratic mission: From AI oligopoly to ecosystem
  • Human-AI collaboration as training methodology
  • Scope-based expertise with hot-swappable LoRA layers

📖 Recipe System

Recipe Architecture:

Module-Level Recipe Docs:

See system/recipes/ for additional recipe documentation:

🧪 Testing Documentation

Testing Strategy & Reports:

🎨 Design Documentation

Core Design Principles:

Interface Design Patterns:

Type Safety & Defaults:

📦 Archived Documentation

Session Notes:

Historical Testing & Validation:

Historical Architecture:

🗂️ Module-Specific Documentation

Many system modules have their own documentation within their directories:

System Core:

  • system/core/router/ - Router enhancement proposals
  • system/core/shared/ - Event architecture
  • system/transports/ - Transport layer architecture

Conversation System:

  • system/conversation/ - ThoughtStream, coordination, MCP tools, cognition events

Data & Events:

  • system/data/ - Data daemon documentation
  • system/events/ - Event coalescing, RAG data completeness

Genome & Fine-Tuning:

  • system/genome/fine-tuning/ - Dataset construction architecture

User System (PersonaUser):

  • system/user/ - AI coordination, turn-taking, protocol architecture
  • system/user/server/modules/ - CRITICAL - Autonomous loop, genome paging, convergence roadmap

RAG System:

  • system/rag/ - RAG adapter architecture

Recipes:

  • system/recipes/ - Multi-persona recipes, adapter extensibility

Resources:

  • system/resources/ - Graceful fallback patterns

Security:

  • system/secrets/ - Security documentation

🚀 Quick Start

For New Developers:

  1. Read CLAUDE.md - Essential development guide
  2. Read ARCHITECTURE-INDEX.md - System overview
  3. Read PERSONA-CONVERGENCE-ROADMAP.md - Current vision

For Fine-Tuning Work:

  1. Read PHASE-7-ROADMAP.md - Complete roadmap
  2. Read PHASE-7-STATUS.md - Current status
  3. Read LORA-GENOME-PAGING.md - Genome architecture
  4. Read AUTONOMOUS-LOOP-ROADMAP.md - Autonomous design

For Recipe System:

  1. Read RECIPES.md - Overview
  2. Read MULTI-PERSONA-RECIPE-GUIDE.md - Coordination

For Testing:

  1. Read PATH-ALIASES-TEST-RESULTS.md - Test examples
  2. Read TEST_COMMAND_ARCHITECTURE.md - Test patterns

📝 Documentation Standards

File Naming:

  • Use UPPERCASE-WITH-DASHES.md for major architectural docs
  • Use lowercase-with-dashes.md for implementation guides
  • Place docs close to the code they document when module-specific
  • Place cross-cutting docs in docs/ subdirectories

Organization Principles:

  • docs/architecture/ - Cross-cutting system architecture
  • docs/personas/ - PersonaUser, genomic, fine-tuning architecture
  • docs/papers/ - Academic research papers on core innovations
  • docs/recipes/ - Recipe system architecture and guides
  • docs/testing/ - Testing strategies and reports
  • docs/design/ - Design patterns and philosophy
  • docs/archive/ - Historical and session documentation
  • system/[module]/ - Module-specific implementation docs

Writing Style:

  • Start with a clear purpose statement
  • Use code examples liberally
  • Link to related documentation
  • Keep docs close to the code they describe
  • Update docs when code changes

Last Updated: 2025-11-26 Total Documentation Files: 71 in docs/ (including 3 research papers, organized into subdirectories), 49 in system/ subdirectories

Recent Changes:

  • Organized design docs into design/principles/ and design/interfaces/ subdirectories
  • Added MEDIA-FORMAT-CONVERSION-ARCHITECTURE.md for bidirectional media conversion
  • Moved VISION-MEDIA-ARCHITECTURE.md to architecture/ directory