Skip to main content

V4 Documentation Index

Complete index of coditect-v4 reference materials copied to the t2 project.

Overview

Total V4 Reference Materials: ~2.2MB

  • Architecture Docs: 3 files (SDD, TDD, CODI design)
  • ADRs: 88 architecture decision records
  • Agent System: Complete agent framework documentation
  • Source Code: 11 directories (~5.3MB, see v4-source-code-reference.md)

Directory Structure

docs/
├── v4-reference/ # Architecture & ADRs (1.7MB)
│ ├── README.md # Reference documentation guide
│ ├── architecture/ # SDD, TDD, CODI design (3 docs)
│ └── adrs/ # 88 ADRs covering all v4 decisions
└── v4-agents/ # Agent system docs (512KB)
├── coditect/ # 10 CODITECT agent definitions
├── coditect-enhanced/ # Enhanced agent variants
├── quick-start-guides/ # Agent onboarding guides
├── templates/ # Agent templates
└── tools/ # Agent tooling scripts

src/
├── frontend-original/ # V4 React frontend (2.6MB)
└── v4-*/ # 10 V4 service directories (2.7MB)

Key Documents

Architecture Documents

DocumentLocationSizePurpose
V4 SDDdocs/v4-reference/architecture/v4-sdd-software-design-document.md20KBSystem overview, components
V4 TDDdocs/v4-reference/architecture/v4-tdd-technical-design-document.md12KBTechnical implementation
CODI Designdocs/v4-reference/architecture/v4-codi-race-free-architecture-design.md26KBConcurrency patterns

Critical ADRs for T2

FoundationDB & Storage:

  • ADR-002-v4-storage-architecture - Keyspace design, data partitioning
  • ADR-006-v4-data-model - User/workspace/session schemas

Multi-Tenant & Security:

  • ADR-003-v4-multi-tenant-architecture - Tenant isolation patterns
  • ADR-005-v4-authentication-authorization - JWT, RBAC, sessions
  • ADR-024-v4-security-hardening-architecture - Security best practices

Monitoring & Observability:

  • ADR-008-v4-monitoring-observability - Logging, metrics, tracing
  • ADR-016-v4-codi-rust-implementation - File monitoring in Rust
  • ADR-031-v4-codi2-monitor-integration - File system event handling

AI & llm Integration:

  • ADR-007-v4-ai-router-architecture - llm provider routing
  • ADR-019-v4-prompt-engine-server-architecture - Prompt optimization
  • ADR-022-v4-llm-log-reranking - Log analysis with llms

System Architecture:

  • ADR-001-v4-container-execution-architecture - Container orchestration
  • ADR-004-v4-api-architecture - API design patterns
  • ADR-017-v4-unified-workspace-architecture - Multi-session management

Agent System Documentation

DocumentPurpose
docs/v4-agents/coditect-sub-agents-master-list.mdComplete agent catalog
docs/v4-agents/multi-session-guide.mdMulti-agent coordination
docs/v4-agents/migration-guide.mdAgent system migration
docs/v4-agents/sub-agent-build-sprint-checklist.mdAgent development workflow
docs/v4-agents/coditect/orchestrator.mdOrchestrator agent definition
docs/v4-agents/coditect/rust-developer.mdRust specialist agent
docs/v4-agents/coditect/frontend-developer.mdFrontend specialist agent

Usage Guidelines

When to Reference V4 Documentation

Reference for:

  1. FoundationDB keyspace design patterns (ADR-002, ADR-006)
  2. Multi-tenant isolation strategies (ADR-003)
  3. Authentication & authorization flows (ADR-005)
  4. File monitoring architecture (ADR-016, ADR-031)
  5. Agent coordination patterns (v4-agents/)
  6. Security hardening approaches (ADR-024)

When NOT to Copy V4 Patterns

Do NOT copy:

  1. workspace architecture - T2 uses theia, not custom React
  2. Container orchestration - Different deployment model
  3. Frontend components - T2 is theia extensions
  4. editor implementation - Use theia's built-in Monaco
  5. terminal implementation - Use theia's built-in terminal

Key Differences: V4 vs T2

AspectV4 (Reference)T2 (Current)Use V4 Docs For
IDECustom React web appEclipse theia extensionsUI patterns, styling ideas
StorageFoundationDB + K8s PVsFoundationDB + OPFSFDB patterns (✅)
Multi-tenantK8s pods per usertheia workspacesIsolation patterns (✅)
AuthJWT + FDB sessionsJWT + FDB sessionsAuth flows (✅)
MonitoringCODI Rust + FDBCODI + file-monitorCODI architecture (✅)
AgentsMulti-agent MCP/A2AMulti-agent MCP/A2AAgent patterns (✅)
editorCustom Monacotheia's Monaco❌ Don't copy
terminalCustom xterm.js podstheia's terminal❌ Don't copy
BuildVite + Cargotheia build❌ Don't copy

Integration with T2 Documentation

T2 Architecture Docs (Primary):

  • docs/CLAUDE.md - Main project guidance
  • docs/sdd.md - T2 Software Design Document
  • docs/tdd.md - T2 Technical Design Document
  • docs/adr/ADR-014-*.md - Eclipse theia decision (CRITICAL)
  • docs/architecture/architecture.md - T2 system architecture

V4 Docs (Reference):

  • Use to validate T2 decisions
  • Learn from V4 successes and mistakes
  • Extract reusable patterns (FDB, auth, monitoring)
  • Understand multi-tenant architecture

ADR Quick Reference

By Number

ADRTitleKey Topic
001Container ExecutionK8s pods, resource limits
002Storage ArchitectureFoundationDB keyspace
003Multi-TenantTenant isolation
004API ArchitectureREST/GraphQL patterns
005Auth/AuthorizationJWT, sessions, RBAC
006Data ModelFDB schemas
007AI Routerllm provider routing
008MonitoringLogging, metrics
009CODI CLICommand interface
010Disaster RecoveryBackup strategies
011Audit/ComplianceGDPR, SOC2
012Code GenerationAI code generation
013Queue ManagementTask queues
014Deployment PipelineCI/CD
015Team CollaborationReal-time collab
016CODI RustFile monitoring
017Unified workspaceMulti-session
018Dynamic CommandsCODI commands
019Prompt EnginePrompt optimization
020Agents.md AdoptionAgent framework
021Hybrid Graph SystemKnowledge graphs
022llm Log RerankingLog analysis
024Security HardeningSecurity best practices
025Migration StrategySystem migration
026Error HandlingError patterns
027Coordination FrameworkMulti-agent coordination
028CODI2 SeparationComponent boundaries
029Server HubCentral server
030Document ServerKBaaS
031Monitor IntegrationFile system events

By Topic

Most Relevant to T2:

  • Storage & Data: ADR-002, ADR-006
  • Multi-Tenant: ADR-003, ADR-005
  • Monitoring: ADR-008, ADR-016, ADR-031
  • AI Integration: ADR-007, ADR-019, ADR-022
  • Architecture: ADR-017, ADR-027, ADR-028

Less Relevant (Different Approach):

  • Container/K8s: ADR-001, ADR-004
  • Deployment: ADR-014, ADR-025
  • Collaboration: ADR-015 (theia has built-in)

Source Code Reference

See docs/v4-source-code-reference.md for details on:

  • src/frontend-original/ - React frontend (2.6MB)
  • src/v4-api-v2/ - Rust/Axum API (432KB)
  • src/v4-websocket-gateway/ - WebSocket gateway (104KB)
  • Plus 8 more v4 service directories

Document Freshness

Copied: 2025-10-06 from coditect-v4 submodule

ADR Status Indicators:

  • Accepted - Implemented and validated
  • 🔄 Superseded - Replaced by newer ADR
  • 📝 Proposed - Design only, not implemented
  • ⚠️ QA Review - Under quality review

Check each ADR's "Status" section for current state.

Search Tips

Find ADRs by Topic

# FoundationDB patterns
grep -r "FoundationDB\|keyspace" docs/v4-reference/adrs/ -l

# Multi-tenant patterns
grep -r "tenant\|isolation" docs/v4-reference/adrs/ -l

# Authentication flows
grep -r "JWT\|authentication\|authorization" docs/v4-reference/adrs/ -l

# CODI monitoring
grep -r "CODI\|monitoring\|file.*watch" docs/v4-reference/adrs/ -l

Find Agent Documentation

# Agent definitions
ls docs/v4-agents/coditect/

# Agent coordination
grep -r "coordination\|handoff\|session" docs/v4-agents/ -l

Next Steps

  1. Read ADR-002 and ADR-006 - FoundationDB patterns for t2
  2. Review CODI design - File monitoring architecture
  3. Study agent system - Multi-agent coordination patterns
  4. Extract FDB schemas - Adapt for theia-based architecture
  5. Learn from mistakes - Read "Alternatives Considered" sections
  • V4 Source Code: docs/v4-source-code-reference.md
  • T2 Main Guidance: docs/CLAUDE.md
  • T2 Architecture: docs/architecture/architecture.md
  • T2 ADRs: docs/adr/ (14+ ADRs specific to t2)

Remember: V4 documentation is for reference and learning. T2 is building a fundamentally different architecture (theia extensions vs. standalone web app). Use V4 patterns selectively and adapt to theia's paradigm.