11 KiB
11 KiB
StellaOps Documentation Index
Master index of all StellaOps documentation. Last updated: 2026-01-05 (Post-consolidation)
This index provides a complete map of documentation organized by audience and topic. The documentation follows a two-level hierarchy:
- Canonical guides (
docs/*.md) - High-level entry points - Detailed references (
docs/**/*) - Module dossiers, API contracts, runbooks
Quick Navigation by Audience
| Audience | Start Here |
|---|---|
| New Users | quickstart.md, overview.md |
| Developers | DEVELOPER_ONBOARDING.md, CODING_STANDARDS.md |
| Architects | ARCHITECTURE_OVERVIEW.md, ARCHITECTURE_REFERENCE.md |
| Operators/SREs | SECURITY_HARDENING_GUIDE.md, OFFLINE_KIT.md |
| Plugin Developers | PLUGIN_SDK_GUIDE.md, dev/ |
Canonical Guides (docs/*.md)
Getting Started
| Document | Purpose |
|---|---|
| README.md | Documentation overview and navigation |
| overview.md | 2-minute product summary |
| quickstart.md | First scan walkthrough |
| DEVELOPER_ONBOARDING.md | Developer setup guide |
| CONCELIER_CLI_QUICKSTART.md | Advisory ingestion quickstart |
Architecture
| Document | Purpose |
|---|---|
| ARCHITECTURE_OVERVIEW.md | 10-minute architecture tour |
| ARCHITECTURE_REFERENCE.md | Full architecture index/map |
| technical/architecture/ | Detailed architecture views |
Features & Capabilities
| Document | Purpose |
|---|---|
| key-features.md | Capability cards with evidence |
| FEATURE_MATRIX.md | Tier-by-tier feature availability |
| full-features-list.md | Complete capability catalog |
Operations & Security
| Document | Purpose |
|---|---|
| SECURITY_HARDENING_GUIDE.md | Deployment security guide |
| SECURITY_POLICY.md | Security incident policy |
| OFFLINE_KIT.md | Air-gapped operation guide |
| UI_GUIDE.md | Console operator guide |
Development
| Document | Purpose |
|---|---|
| CODING_STANDARDS.md | Code quality rules |
| PLUGIN_SDK_GUIDE.md | Plugin development guide |
| VEX_CONSENSUS_GUIDE.md | VEX consensus and trust |
Reference
| Document | Purpose |
|---|---|
| API_CLI_REFERENCE.md | API and CLI reference hub |
| GLOSSARY.md | Platform terminology |
| ROADMAP.md | Product roadmap |
Module Documentation (docs/modules/)
Module dossiers contain architecture, operations, and API documentation per component.
Naming Convention: Module directories use kebab-case (e.g.,
binary-index,sbom-service)
Core Platform
| Module | Directory | Description |
|---|---|---|
| Authority | authority/ | OAuth/OIDC, DPoP authentication |
| Gateway | gateway/ | API gateway, routing |
| Router | router/ | Transport-agnostic messaging |
| Platform | platform/ | Console backend aggregation |
Data Ingestion
| Module | Directory | Description |
|---|---|---|
| Concelier | concelier/ | Advisory ingestion |
| Excititor | excititor/ | VEX document ingestion |
| VexLens | vex-lens/ | VEX consensus computation |
| VexHub | vex-hub/ | VEX distribution hub |
| IssuerDirectory | issuer-directory/ | Issuer trust registry |
| Feedser | feedser/ | Backport detection evidence |
Scanning & Analysis
| Module | Directory | Description |
|---|---|---|
| Scanner | scanner/ | Container scanning, SBOM generation |
| BinaryIndex | binary-index/ | Binary fingerprinting |
| AdvisoryAI | advisory-ai/ | AI-assisted analysis |
| Symbols | symbols/ | Symbol resolution |
| ReachGraph | reach-graph/ | Reachability graphs |
Artifacts & Evidence
| Module | Directory | Description |
|---|---|---|
| Attestor | attestor/ | DSSE/in-toto attestations |
| Signer | signer/ | Cryptographic signing |
| SbomService | sbom-service/ | SBOM storage, lineage |
| EvidenceLocker | evidence-locker/ | Sealed evidence storage |
| ExportCenter | export-center/ | Batch export |
| Provenance | provenance/ | SLSA attestation |
Policy & Risk
| Module | Directory | Description |
|---|---|---|
| Policy | policy/ | K4 lattice policy engine |
| RiskEngine | risk-engine/ | Risk scoring |
| VulnExplorer | vuln-explorer/ | Vulnerability triage |
| Unknowns | unknowns/ | Unknown component tracking |
| FindingsLedger | findings-ledger/ | Findings tracking |
Operations
| Module | Directory | Description |
|---|---|---|
| Scheduler | scheduler/ | Job scheduling |
| Orchestrator | orchestrator/ | Workflow orchestration |
| TaskRunner | taskrunner/ | Task pack execution |
| Notify | notify/ | Notifications |
| Notifier | notifier/ | Notifications Studio |
| PacksRegistry | packs-registry/ | Task packs registry |
| TimelineIndexer | timeline-indexer/ | Event indexing |
| Replay | replay/ | Deterministic replay |
Integration
| Module | Directory | Description |
|---|---|---|
| CLI | cli/ | Command-line interface |
| Zastava | zastava/ | Registry webhooks |
| Web/UI | ui/, web/ | Frontend SPA |
Infrastructure
| Module | Directory | Description |
|---|---|---|
| Cryptography | cryptography/ | Crypto profiles |
| Telemetry | telemetry/ | Observability |
| Graph | graph/ | Call graph structures |
| Signals | signals/ | Runtime signals |
| AirGap | airgap/ | Air-gap support |
| AOC | aoc/ | Append-Only Contract |
Cross-Cutting Concepts
| Concept | Directory | Description |
|---|---|---|
| Snapshot | snapshot/ | Point-in-time captures |
| Triage | triage/ | Vulnerability triage workflows |
| Provcache | prov-cache/ | Provenance cache (library) |
| Benchmark | benchmark/ | Competitive benchmarking |
| Bench | bench/ | Performance benchmarks |
Specialized Documentation Areas
API Documentation
| Area | Path | Description |
|---|---|---|
| API Overview | api/overview.md | API conventions |
| Gateway APIs | api/gateway/ | Gateway endpoints |
| Console APIs | api/console/ | Console endpoints |
| Signal Contracts | api/signals/ | Signal contracts |
Air-Gap Operations
| Area | Path | Description |
|---|---|---|
| Overview | airgap/overview.md | Air-gap overview |
| Operations | airgap/operations.md | Operational guides |
| Bundles | airgap/ | Bundle formats |
Database
| Area | Path | Description |
|---|---|---|
| Specification | db/SPECIFICATION.md | Database spec |
| Migrations | db/tasks/ | Migration phases |
| Schemas | db/schemas/ | Schema definitions |
CLI Reference
| Area | Path | Description |
|---|---|---|
| Command Reference | cli/command-reference.md | Complete CLI reference |
| Admin Commands | cli/admin-reference.md | Admin commands |
| Crypto Commands | cli/crypto-commands.md | Crypto operations |
End-to-End Flows
| Area | Path | Description |
|---|---|---|
| Flow Index | flows/README.md | All workflow flows |
| Scan Flow | flows/02-scan-submission-flow.md | Scan submission |
| Policy Flow | flows/04-policy-evaluation-flow.md | Policy evaluation |
| CI/CD Flow | flows/10-cicd-gate-flow.md | CI/CD gating |
Technical Deep Dives
| Area | Path | Description |
|---|---|---|
| Architecture Index | technical/architecture/ | Architecture views |
| User Flows | technical/architecture/user-flows.md | UML diagrams |
| Module Matrix | technical/architecture/module-matrix.md | 46-module matrix |
Contracts & ADRs
| Area | Path | Description |
|---|---|---|
| Contracts | contracts/ | Technical contracts |
| ADRs | adr/ | Architecture decisions |
Development Guides
| Area | Path | Description |
|---|---|---|
| Plugin Development | dev/ | Plugin guides & templates |
| Scanner Engine | dev/scanning-engine.md | Scanner internals |
Benchmarks & Testing
| Area | Path | Description |
|---|---|---|
| Benchmarks | benchmarks/ | Performance & accuracy |
| Ground Truth | benchmarks/ground-truth-corpus.md | Test datasets |
Risk Scoring
| Area | Path | Description |
|---|---|---|
| Risk Samples | risk/samples/ | Risk scoring examples |
Implementation Planning
| Area | Path | Description |
|---|---|---|
| Sprint Files | implplan/ | Active implementation sprints |
| Archived Sprints | ../docs-archived/implplan/ | Completed sprints |
External References
- CLAUDE.md (repository root) - Claude Code instructions and module table
- src/__Tests/AGENTS.md - Test infrastructure guidance
- Module AGENTS.md files - Per-module development instructions
Changelog
| Date | Change |
|---|---|
| 2026-01-05 | Created index; renamed module directories to kebab-case; updated CLAUDE.md with missing modules |