Skip to content

INDEX.md

Latest commit

 

History

History
261 lines (210 loc) · 17 KB

INDEX.md

File metadata and controls

261 lines (210 loc) · 17 KB
Raw

Atom Documentation Index

Last Updated: August 2026
Version: v8.0.0 (main_api_app, 197 routers)
Purpose: Comprehensive index of all Atom documentation with quick links and descriptions

📚 Documentation Hub — Browse by category (Getting Started, Security, Intelligence, Orchestration, Integrations, Development)

Quick Start by Role

Role Start Here Time
New User Quick Start 15 min
Developer Development Setup + Makefile 20 min
Admin Production Readiness 30 min
AI Engineer LLM Providers Guide 15 min

📚 Documentation by Category

🚀 Getting Started & Operations

Document Description Audience
Quick Start Fastest path to running local server All
Installation Complete setup (native, Docker, cloud) All
First Steps What to do after server is running New Users
Troubleshooting Common errors and fixes All
Run with Ollama Free local LLM setup (no API keys) Cost-conscious
Personal Edition Local Docker + SQLite deployment Self-hosters
Production Readiness Pre-flight checklist for staging/prod Admins
Monitoring & Health Prometheus, health checks, alerts Admins/DevOps

🛡️ Security & Governance

Document Description Audience
Execution Sandbox Layer 5-phase blast-radius defense (default-on) All
Execution Sandbox Concept Guide NEW - Deep dive: phases, config, tripwires Security/Architects
Trust vs Sandbox Why maturity routing ≠ security boundary Architects
Prompt Injection Defense Defense plan (implemented) Security
Data Protection Fernet encryption, secrets, migration Admins
Package Security Python/npm scanning, sandbox controls Devs
Webhook Verification Slack/Teams/Gmail signature verification Devs
LLM Gateway Subscription Reuse ChatGPT Plus / Claude Pro OAuth Admins

🧠 Intelligence & Memory

Document Description Audience
Context Memory Per-turn fact extraction, 2-tier recall AI Engineers
Memory Systems Concept Guide NEW - Three tiers, episodic, self-evolution AI Engineers
Agent Hybrid Search NEW - BM25 + vector RRF fusion for documents.search AI Engineers
Knowledge VFS NEW - Agent-native ls/cat/grep over documents AI Engineers
Oracle Verification NEW - Postcondition oracle, two-tier confidence AI Engineers
Reviewer Loop NEW - Re-delegation on review rejection, diversity MoA AI Engineers
Agent Environment NEW - Goal-driven loop, utility targets, stuck-detection AI Engineers
Learning LLM Router Per-model predictors, feedback re-ranking AI Engineers
Episodic Memory Agent learning framework AI Engineers
GraphRAG Knowledge graph, entity extraction AI Engineers
Cognitive Tier System 5-tier LLM routing AI Engineers
Arbor Framework Hypothesis Tree Refinement (MCTS) Researchers
Stage Router / Switchyard NEW - Shadow-first turn-level LLM routing, A/B harness, consent-gated automation AI Engineers
Self-Evolving Harness Offline trace analysis, auto-patches Researchers
Hermes Comparison Atom vs Hermes — what we built/didn't Architects
Agent Harness Research NEW - Citation-backed survey: guardrails, voting vs debate, multi-agent orgs, memory, verified execution, harness benchmarks Researchers/AI Engineers
BPE Workspace Plan NEW - Research-grounded plan: Belief/Progress/Experience runtime workspace (EvoHarness-RL) with track/commit/recall/note meta-actions and cost-aware consult policy Researchers/AI Engineers

👥 Agent Systems & Orchestration

Document Description Audience
Agent Overview System overview, intent classification All
Agent Maturity & Governance NEW - Tier system, governance flow, graduation All
Queen Agent User Guide Structured workflow automation Users/Admins
Queen vs Fleet Admiral Which orchestrator to use Architects
Fleet Admiral Multi-agent fleet coordination AI Engineers
Fleet Orchestration NEW - CSO→Division→Specialist wiring, ranked matching AI Engineers
Agent Radio / Lateral Messaging NEW - Peer-to-peer agent messaging (mention-first) AI Engineers
Unstructured Tasks Intent classification & dynamic routing AI Engineers
Agent Guidance System Real-time operation tracking Users
Agent Graduation Promotion criteria & validation Admins
Student Training Maturity system (STUDENT→AUTONOMOUS) Architects
Round 87 — Agent Journey Updates NEW - Linked-evidence completion, agent persona chat, ontology/file introspection, mini canvas, voice opt-in All
Agent Workspace Live Trace NEW - Real-time execution steps + reasoning trace in agent chat, per-step feedback → training, trace replay API, auto-show/hide All

🔌 Integrations & LLM Providers

Document Description Audience
LLM Providers Guide NEW - All providers, setup, costs All
OpenCode Go Provider NEW - Low-cost subscription gateway Cost-conscious
Ollama Local LLM Free local inference Cost-conscious
BYOK Integration Multi-provider LLM setup Devs
Integrations Overview 44+ service integrations Devs
Third-Party App Integrations NEW Complete guide: 44+ native, OAuth, governance, webhooks, custom Devs/Architects
Browser Automation Playwright CDP, INTERN+ required Devs
Device Capabilities Camera, screen, location, exec Devs
Deep Linking atom:// URLs for external apps Devs
Marketplace Commercial marketplace (atomagentos.com) Enterprise
Org Ingestion Sharing NEW - Signed profiles/bundles + hub: share ingestion config, org data & GraphRAG memory between org members' local instances Self-hosters/Admins
Org Sharing Setup Runbook NEW - Hub/member setup, key ceremony, sensitivity policy, rotation, validation checklist Admins/Self-hosters
Agent Memory Unification NEW - Research-grounded plan: unified turn-time memory retrieval (comms + GraphRAG + episodes + turn facts) for chat/IM surfaces, tool equality, consolidation Devs/Architects
Installation Adaptation NEW - Research-grounded plan: new installs reach competence via profile data, playbooks (procedural memory), auto-generated evals, reflection + grounded sends — no per-install code changes Architects/Product

🎨 Canvas & Office Automation

Document Description Audience
Canvas System Presentations, charts, forms, full CRUD + integration Users/Devs
Canvas Reference Complete API reference, governance, WebSocket Devs
Office Automation Word/Excel/PowerPoint co-editing Users
Workbook Runtime Excel formula evaluation engine Devs
Mini-Apps Architecture Stateful canvas apps (agent-authored) AI Engineers
Mini-Apps User Guide Create, run, collaborate on mini-apps Users/Devs
Canvas AI Accessibility Dual representation for agents AI Engineers
Canvas State API JavaScript real-time state API Frontend Devs
LLM Canvas Summaries Semantic summaries for memory AI Engineers

🔐 Authentication & Federation

Document Description Audience
Authentication OAuth 2.0, sessions, validation Devs
Federation DID/VC zero-trust multi-instance Architects
OAuth Quick Setup Provider OAuth in 5 minutes Devs
OAuth Setup Checklist Complete OAuth configuration Admins

📱 Mobile & Frontend

Document Description Audience
Mobile Quick Start React Native setup Mobile Devs
Mobile Architecture React Native with Expo Mobile Devs
Mobile Secure Storage Keychain/EncryptedSharedPreferences Mobile Devs
Frontend XSS Protection DOMPurify sanitization Frontend Devs

🛠️ Development & Testing

Document Description Audience
Development Setup Venv, Makefile, code style (macOS/Linux) Devs
Code Quality Type hints, mypy, Google docstrings Devs
E2E Testing Guide 486 tests, API-first auth, POM QA/Devs
Testing Index Unit, integration, E2E, bug discovery Devs
Bug Discovery Fuzzing, property-based, chaos QA
Stress Testing k6, network sim, failure injection QA
API Standards Response formats, error codes Devs
Database Migrations Alembic + SQLite hybrid patterns Devs
Makefile Reference make setup, make backend, make test Devs

📊 Reference

Document Description
Environment Variables Complete — every var, default, required
Routing Headers x-atom-* header overrides
Routing Strategies BPC, fusion, cascade, LKGP
API Overview All endpoints
API Contract Testing Schema validation
Technical Overview High-level system design
Code Structure Code organization
Database Architecture Schema, relationships
Feature Matrix Feature availability by tier

🔍 Discover by Topic

LLM Configuration

Security Hardening

Agent Maturity & Governance

Memory & Context

Canvas & Office

Third-Party Integrations

⚖️ Comparisons

Document Description Audience
Atom vs Hermes Honest capability matrix: memory, routing, sandbox, governance, self-evolution AI Engineers, Architects
Atom vs OpenClaw Feature-by-feature: governance, memory, integrations, testing, security Evaluators, Decision-makers

🗂️ Archive (Legacy / Historical)

These documents are retained for historical reference. Prefer the active docs above.

Document Note
Implementation History Consolidated timeline
BYOK V6 Migration Historical migration
Canvas Implementation Historical
Old Guides Superseded by current guides

🔗 External References

🆘 Need Help?

  1. Setup issues → Troubleshooting
  2. Auth problems → Authentication
  3. LLM not working → LLM Providers Guide
  4. Agent not executing → Agent Overview + Governance
  5. Performance → Monitoring + Performance

Found an issue? Report on GitHub or contribute via PR.
Keep docs current — update when you change behavior.

Last Updated: August 2026