Documentation Index¶
The clean map of all AegisAgent documentation, organized by how deep you want to go. Start at START_HERE.md if you're new.
Start here (Level 1 — anyone)¶
| Doc | What it gives you |
|---|---|
| START_HERE.md | The front door: three reading paths by role |
| The_One_Minute_Tour.md | The whole idea in 60 seconds |
| What_Is_AegisAgent.md | What it is (and is not) |
| Why_AegisAgent.md | The three problems it solves |
| How_It_Works.md | The mechanism, step by step |
| Product_Overview.md | The full product framing |
| Glossary.md | Every term, simple + technical |
| faq.md | 25 honest questions and answers |
Product understanding¶
Last_Mile_System_Walkthrough.md (the whole system as one story) · concepts.md · mission.md · getting-started.md · current-vs-roadmap.md
Flows (Level 2 — visual understanding)¶
| Flow | Status |
|---|---|
| Known agent | Implemented |
| Approval | Implemented |
| Receipt | Implemented |
| SOC incident | Implemented |
| Ban & quarantine | Partial |
| MCP gateway | Implemented |
| Prompt-to-action lineage | Partial |
| Unknown agent (cage) | Partial/Planned |
| Control command | Partial/Planned |
| Tool broker | Planned |
| Egress block | Planned |
Architecture (Level 3 — engineers & architects)¶
Canonical v2 blueprint: root HLD · LLD · migration matrix · 36-week roadmap. Current system references: Architecture_Overview.md · AegisAgent_Technical_Design.md · security-model.md · AegisAgent_Threat_Model.md · fail-closed-behavior.md · database-schema.md · runtime-authorization-api.md + api-reference.md · event-schema.md · action-receipt-spec.md · evidence-graph.md · AegisAgent_Runtime_Data_Plane.md · prior target working documents: AegisAgent_World_Class_HLD.md, AegisAgent_World_Class_LLD.md · decisions: adr/index.md.
Components (Level 4 — maintainers)¶
Gateway · SDK · Policy engine · Approval engine · Receipt engine · SOC engine · MCP gateway · Storage · Console UI · Prompt & model capture · planned: Agent cage · Node sensor · Egress proxy · Tool broker
Developer docs (Level 5)¶
Local_Development.md · quickstart.md · installation.md · onboarding/For_SDK_Developer.md (SDK integration) · sdk-parity-status.md · api-versioning.md · demos: approve-then-swap-demo.md, demo-github-attack.md
Operator docs (Level 5)¶
deployment-guide.md · production-hardening.md (production checklist) · AegisAgent_Operational_Design.md · runbooks/index.md · AegisAgent_Debugging_Guide.md · performance-baseline.md · performance-tuning-guide.md · integrations: github-integration.md, slack-integration.md, qdrant-integration.md
Onboarding (per role)¶
New engineer · Security architect · SOC analyst · SDK developer · Frontend engineer · DevOps engineer
Maintainer docs (Level 6)¶
Repo_Knowledge_Map.md (repo map + code flow) · Implementation_Status.md (the honest ledger) · AegisAgent_Diagram_Index.md + diagrams/ · architecture-map.json (machine-readable system map) · explorer/index.html (optional interactive map) · Documentation_Audit.md · Documentation_Redesign_Plan.md · documentation standard + component template · feature_history.md · architecture.md (mandatory code patterns) · PR workflow: CONTRIBUTING.md · backlog process: Issue_Backlog_Execution_Plan.md
Internal strategy (not published to the docs site)¶
AegisAgent_Gap_Reassessment_2026-06.md (source of truth) · AegisAgent_Vision / PRD / Problem_Definition / Market_Gap_Analysis / Product_Research / GTM — see docs/README.md for the full internal list.
Archive¶
Superseded documents live in archive/ with a note explaining what replaced them.