Documentation Directory - Agent Guide¶

docs/
├── README.md                    # Human navigation hub
├── AGENTS.md                    # This file - AI navigation
├── ROADMAP.md                   # Post-MVP features and direction
├── openapi.json                 # OpenAPI specification
│
├── ai/                          # AI model zoo documentation
│   ├── AGENTS.md                # AI docs navigation
│   └── model-zoo.md             # Model zoo architecture
│
├── api/                         # API governance documentation
│   ├── AGENTS.md                # API docs navigation
│   └── migrations/              # Migration guides
│
├── archive/                     # Archived working documents
│   ├── AGENTS.md                # Archive navigation
│   └── *.md                     # Historical documents
│
├── architecture/                # System design documentation
│   ├── AGENTS.md                # Architecture navigation
│   ├── overview.md              # High-level architecture
│   ├── ai-pipeline.md           # AI pipeline details
│   ├── data-model.md            # Database schema
│   ├── decisions.md             # Architecture decisions
│   ├── frontend-hooks.md        # Frontend hooks architecture
│   ├── real-time.md             # WebSocket and pub/sub
│   ├── resilience.md            # Circuit breakers, retries
│   └── system-page-pipeline-visualization.md
│
├── benchmarks/                  # Performance benchmarks
│   ├── AGENTS.md                # Benchmarks navigation
│   ├── README.md                # Benchmarks overview
│   └── model-zoo-benchmark.md   # Model zoo benchmarks
│
├── decisions/                   # Architectural Decision Records
│   ├── AGENTS.md                # Decisions navigation
│   └── *.md                     # Individual ADRs
│
├── developer/                   # Developer documentation
│   ├── README.md                # Hub: Architecture, API, patterns
│   ├── AGENTS.md                # Developer docs navigation
│   ├── api/                     # API guides
│   ├── architecture/            # Architecture guides
│   ├── contributing/            # Contribution guide + tool guides
│   ├── patterns/                # Code patterns
│   └── *.md                     # Topic-specific docs (testing, git workflow,
│                                #   code quality, hooks, multi-GPU, ...)
│
├── development/                 # Redirect stubs (consolidated into developer/)
│
├── getting-started/             # Installation and setup
│   ├── AGENTS.md                # Getting started navigation
│   ├── prerequisites.md         # System requirements
│   ├── installation.md          # Installation guide
│   ├── first-run.md             # First run guide
│   └── upgrading.md             # Upgrade guide
│
├── guides/                      # Feature guides
│   ├── AGENTS.md                # Guides navigation
│   ├── video-analytics.md       # AI pipeline and detection features
│   ├── zone-configuration.md    # Detection zone setup
│   ├── face-recognition.md      # Face detection and re-ID
│   └── profiling.md             # Continuous profiling guide
│
├── images/                      # Diagrams and screenshots
│   ├── AGENTS.md                # Images navigation
│   ├── style-guide.md           # Visual style guide
│   ├── SCREENSHOT_GUIDE.md      # Screenshot capture guide
│   └── */                       # Organized subdirectories
│
├── operations/                  # Operational runbooks
│   ├── AGENTS.md                # Operations navigation
│   └── profiling-runbook.md     # Pyroscope profiling operations
│
├── style-guides/                # Documentation style guides
│   ├── AGENTS.md                # Style guides navigation
│   └── diagrams.md              # Mermaid diagram style guide
│
├── vss-integration/             # NVIDIA VSS pipeline research (in progress)
│   ├── AGENTS.md                # VSS research navigation
│   ├── README.md                # Human entry point
│   ├── 00-context.md            # Goal, repos, decision this feeds
│   ├── 01-vss-architecture.md   # VSS service map and pipeline mapping
│   ├── 02-model-inventory.md    # Models, slots, consumer-GPU sizing
│   ├── 03-open-questions.md     # Open question register
│   ├── 04-fp4-and-deployment.md # FP4, local paths, verified consumer fit
│   ├── 05-hardware-profiles.md  # Hardware tiering strategy
│   ├── 06-repo-a-readiness.md   # Repo-A defects blocking a swap
│   └── 07-lean-backend.md       # Storage/bus abstraction; overlay play
│
├── operator/                    # Operator documentation
│   ├── README.md                # Hub: Deployment, monitoring, admin
│   ├── AGENTS.md                # Operator navigation
│   ├── admin/                   # Administration guides
│   ├── deployment/              # Deployment guides
│   ├── monitoring/              # Monitoring guides
│   └── *.md                     # Topic-specific docs
│
├── performance/                 # Performance documentation
│   ├── AGENTS.md                # Performance navigation
│   └── LOAD_PROFILES.md         # Load testing profiles
│
├── plans/                       # Implementation plans
│   ├── README.md                # Plans overview
│   └── *.md                     # Individual design plans
│
├── reference/                   # Reference material
│   ├── AGENTS.md                # Reference navigation
│   ├── README.md                # Reference hub
│   ├── glossary.md              # Terms and definitions
│   ├── accessibility.md         # Accessibility guide
│   ├── models.md                # Model reference
│   ├── stability.md             # API stability
│   ├── config/                  # Configuration reference
│   └── troubleshooting/         # Troubleshooting guides
│
├── templates/                   # Document templates
│   ├── AGENTS.md                # Templates navigation
│   └── AGENTS.md.template       # AGENTS.md file template
│
├── testing/                     # Testing documentation
│
├── ui/                          # Page-by-page UI documentation
│   ├── AGENTS.md                # UI docs navigation
│   ├── README.md                # UI pages index
│   └── *.md                     # Page-specific docs
│
├── deployment/                  # Container orchestration docs
│   └── container-orchestration.md  # Startup, health checks, recovery
│
└── user/                        # End-user documentation hub
    ├── AGENTS.md                # User docs navigation
    └── README.md                # Hub: Dashboard, alerts, features

# Support/asset directories (no hub role):
├── _includes/                   # MkDocs snippet includes (auth-model, risk-scoring)
├── components/                  # UI component documentation (see components/AGENTS.md)
├── diagrams/                    # Diagram sources
├── discoveries/                 # NEM-tagged discovery notes
├── examples/                    # Prompt-engineering examples
├── archive/                     # Historical point-in-time reports, snapshots &
│                                #   NEM investigations (see archive/AGENTS.md)
├── research/                    # Numbered research studies
├── stylesheets/                 # MkDocs custom CSS
└── superpowers/                 # Agent handoff/plan documents