Skip to content

Latest commit

 

History

History
144 lines (118 loc) · 7.04 KB

File metadata and controls

144 lines (118 loc) · 7.04 KB

REPLOID Documentation Index

Guide to all documentation in the REPLOID project.


Getting Started

  1. /README.md - Project overview, quick start, RSI concepts
  2. docs/QUICK-START.md - Detailed setup and first run
  3. docs/CONFIGURATION.md - Connection modes and boot configuration

Core Documentation

Architecture

Key Blueprints:

Vision and Contracts

Reference


Code Organization

reploid/
├── self/                       # Browser application and public root
│   ├── index.html              # Entry point
│   ├── entry/seed-vfs.js       # VFS hydration compatibility shim
│   ├── entry/start-app.js      # Bootstrapper compatibility shim
│   ├── sw-module-loader.js     # Service worker for VFS modules
│   │
│   ├── host/                   # VFS seeding and runtime handoff
│   ├── kernel/                 # Immutable boot shell
│   ├── capsule/                # Capsule UI
│   │
│   ├── core/                   # Core substrate
│   │   ├── agent-loop.js       # Cognitive cycle (Think -> Act -> Observe)
│   │   ├── vfs.js              # Virtual filesystem (IndexedDB)
│   │   ├── llm-client.js       # Multi-provider LLM abstraction
│   │   ├── tool-runner.js      # Dynamic tool loading/execution
│   │   └── verification-manager.js  # Pre-flight safety checks
│   │
│   ├── infrastructure/         # Support services
│   │   ├── event-bus.js        # Pub/sub event system
│   │   ├── di-container.js     # Dependency injection
│   │   ├── hitl-controller.js  # Human-in-the-loop oversight
│   │   └── audit-logger.js     # Execution logging
│   │
│   ├── capabilities/           # Extended capabilities
│   │   └── communication/      # Swarm sync, WebRTC transport
│   │
│   ├── tools/                  # Agent tools (CamelCase)
│   │
│   ├── config/                 # Configuration
│   │   └── genesis-levels.json # Module/worker/role definitions
│   │
│   ├── blueprints/             # Architectural specifications
│   │   └── (216+ design docs)
│   │
├── tests/                      # Test suites
│
├── docs/                       # Human-facing documentation
└── server/                     # Proxy server

Reading Guide

For New Users

  1. README.md - Understand REPLOID
  2. QUICK-START.md - Get running
  3. CONFIGURATION.md - Configure connections

For Developers

  1. system-architecture.md - Understand architecture
  2. blueprints/README.md - Study specifications
  3. API.md - Learn module APIs
  4. tools/README.md - Tool development

For RSI Research

  1. README.md - Core RSI thesis
  2. blueprints/0x000015-dynamic-tool-creation.md - Tool creation
  3. blueprints/0x00005B-recursive-goal-decomposition.md - Recursive goal decomposition
  4. blueprints/0x000112-recursive-gepa-ring.md - Recursive GEPA Ring whole-system recursive improvement blueprint

For Security Researchers

  1. SECURITY.md - Security model and containment
  2. blueprints/0x000040-verification-manager.md - Verification and sandbox design
  3. blueprints/0x00005C-circuit-breaker-pattern.md - Failure containment

Quick Reference

Key Files:

  • ./self/config/genesis-levels.json - Module registry and worker types
  • ./self/entry/seed-vfs.js - VFS hydration compatibility shim
  • ./self/entry/start-app.js - Application bootstrap compatibility shim
  • ./self/index.html - Entry point

Key Directories:

  • ./self/ - Agent substrate modules and public web root
  • ./self/tools/ - Dynamic agent tools
  • ./self/infrastructure/ - Support services
  • ./self/ui/ - Proto UI
  • ./self/blueprints/ - Architectural specifications
  • docs/ - Human-facing documentation. Internal module system invariants and migration checklist live in the private wrapper repo.

External Links:

  • DOPPLER - WebGPU inference engine (separate repo)

Last updated: March 2026