stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity

docs consolidation and others

Browse Source
This commit is contained in:
master
2026-01-06 19:02:21 +02:00
parent d7bdca6d97
commit 4789027317
849 changed files with 16551 additions and 66770 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/INDEX.md
View File

@@ -1,7 +1,7 @@
# StellaOps Documentation Index
> **Master index of all StellaOps documentation.**
> Last updated: 2026-01-05 (Post-consolidation)
> Last updated: 2026-01-06 (Pass 5 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
@@ -46,6 +46,14 @@ This index provides a complete map of documentation organized by audience and to
| [FEATURE_MATRIX.md](FEATURE_MATRIX.md) | Tier-by-tier feature availability |
| [full-features-list.md](full-features-list.md) | Complete capability catalog |
### Product Strategy
| Document | Purpose |
|----------|---------|
| [product/](product/) | Product strategy and positioning hub |
| [product/competitive-landscape.md](product/competitive-landscape.md) | 15-vendor competitive analysis |
| [product/decision-capsules.md](product/decision-capsules.md) | Decision Capsules concept |
| [product/moat-strategy-summary.md](product/moat-strategy-summary.md) | Strategic positioning |
### Operations & Security
| Document | Purpose |
|----------|---------|
@@ -175,9 +183,10 @@ Module dossiers contain architecture, operations, and API documentation per comp
### Air-Gap Operations
| Area | Path | Description |
|------|------|-------------|
| Overview | [airgap/overview.md](airgap/overview.md) | Air-gap overview |
| Operations | [airgap/operations.md](airgap/operations.md) | Operational guides |
| Bundles | [airgap/](airgap/) | Bundle formats |
| Overview | [modules/airgap/](modules/airgap/) | Air-gap module dossier |
| Guides | [modules/airgap/guides/](modules/airgap/guides/) | Air-gap operational guides |
| Runbooks | [modules/airgap/runbooks/](modules/airgap/runbooks/) | Air-gap runbooks |
| Samples | [modules/airgap/samples/](modules/airgap/samples/) | Air-gap bundle samples |
### Database
| Area | Path | Description |
@@ -189,9 +198,11 @@ Module dossiers contain architecture, operations, and API documentation per comp
### CLI Reference
| Area | Path | Description |
|------|------|-------------|
| Command Reference | [cli/command-reference.md](cli/command-reference.md) | Complete CLI reference |
| Admin Commands | [cli/admin-reference.md](cli/admin-reference.md) | Admin commands |
| Crypto Commands | [cli/crypto-commands.md](cli/crypto-commands.md) | Crypto operations |
| CLI Module | [modules/cli/](modules/cli/) | CLI module dossier |
| Quickstart | [modules/cli/guides/quickstart.md](modules/cli/guides/quickstart.md) | CLI quickstart guide |
| Command Reference | [modules/cli/guides/commands/reference.md](modules/cli/guides/commands/reference.md) | Complete CLI reference |
| Admin Commands | [modules/cli/guides/admin/admin-reference.md](modules/cli/guides/admin/admin-reference.md) | Admin commands |
| Crypto Commands | [modules/cli/guides/crypto/crypto-commands.md](modules/cli/guides/crypto/crypto-commands.md) | Crypto operations |
### End-to-End Flows
| Area | Path | Description |
@@ -219,6 +230,22 @@ Module dossiers contain architecture, operations, and API documentation per comp
|------|------|-------------|
| Plugin Development | [dev/](dev/) | Plugin guides & templates |
| Scanner Engine | [dev/scanning-engine.md](dev/scanning-engine.md) | Scanner internals |
| SDK Documentation | [dev/sdks/](dev/sdks/) | Language SDKs and plugin templates |
### Testing & Quality
| Area | Path | Description |
|------|------|-------------|
| Testing Guides | [technical/testing/](technical/testing/) | Testing strategy and guides |
| Determinism | [technical/testing/DETERMINISM_DEVELOPER_GUIDE.md](technical/testing/DETERMINISM_DEVELOPER_GUIDE.md) | Determinism verification |
| Performance | [technical/testing/PERFORMANCE_BASELINES.md](technical/testing/PERFORMANCE_BASELINES.md) | Performance baselines |
| CI Quality Gates | [technical/testing/ci-quality-gates.md](technical/testing/ci-quality-gates.md) | CI quality gates |
### Migration & Upgrades
| Area | Path | Description |
|------|------|-------------|
| Migration Guides | [technical/migration/](technical/migration/) | Schema and API migrations |
| CycloneDX 1.6 to 1.7 | [technical/migration/cyclonedx-1-6-to-1-7.md](technical/migration/cyclonedx-1-6-to-1-7.md) | CycloneDX migration |
| Policy Parity | [technical/migration/policy-parity.md](technical/migration/policy-parity.md) | Policy migration |
### Benchmarks & Testing
| Area | Path | Description |
@@ -229,7 +256,21 @@ Module dossiers contain architecture, operations, and API documentation per comp
### Risk Scoring
| Area | Path | Description |
|------|------|-------------|
| Risk Samples | [risk/samples/](risk/samples/) | Risk scoring examples |
| Risk Samples | [modules/risk-engine/samples/](modules/risk-engine/samples/) | Risk scoring examples |
### Operations & Deployment
| Area | Path | Description |
|------|------|-------------|
| Deployment | [operations/deployment/](operations/deployment/) | Docker, containers, version matrix |
| Runbooks | [operations/](operations/) | Operational runbooks |
| Releases | [releases/](releases/) | Release process, versioning |
### Security
| Area | Path | Description |
|------|------|-------------|
| Security Index | [security/README.md](security/README.md) | Security documentation hub |
| Threat Models | [security/](security/) | Authority, console security |
| Hardening | [SECURITY_HARDENING_GUIDE.md](SECURITY_HARDENING_GUIDE.md) | Deployment hardening |
---
@@ -254,4 +295,9 @@ Module dossiers contain architecture, operations, and API documentation per comp
| Date | Change |
|------|--------|
| 2026-01-05 | Created index; renamed module directories to kebab-case; updated CLAUDE.md with missing modules |
| 2026-01-06 | **Pass 5**: Reduced top-level directories from 41 to 22. Consolidated: docs/accessibility/ to modules/ui/guides/accessibility/; docs/advisories/ to modules/concelier/guides/; docs/events/ to modules/signals/events/; docs/handoff/ to operations/handoff/; docs/roadmap/ to product/roadmap/; docs/schemas/ to modules/attestor/schemas/; docs/sdks/ to dev/sdks/; docs/specs/ to modules/symbols/specs/; docs/task-packs/ to modules/packs-registry/guides/; docs/ux/ to modules/ui/guides/ux/; docs/rfcs/ to adr/; docs/architecture/ to technical/architecture/; docs/data/ to modules/replay/schemas/; docs/testing/ (26 files) to technical/testing/; docs/diagrams/ to technical/diagrams/; docs/migration/ to technical/migration/; docs/process/ to operations/process/; docs/samples/ distributed to respective module samples/ directories (airgap, platform, evidence-locker, excititor, binary-index, concelier, scanner, signals). Fixed ui/guides file to guides-overview.md. |
| 2026-01-06 | **Pass 4**: Consolidated docs/airgap/ (38 files) into modules/airgap/guides/, runbooks/, gaps/, schemas/, samples/; consolidated docs/aoc/ into modules/aoc/guides/; consolidated docs/policy/ (20 files + fixtures/schemas) into modules/policy/guides/, fixtures/, schemas/; consolidated docs/replay/ into modules/replay/guides/; consolidated docs/uncertainty/ into modules/unknowns/guides/; consolidated docs/forensics/ into modules/evidence-locker/, provenance/, timeline-indexer/ guides/; consolidated docs/ingestion/ into modules/concelier/guides/; consolidated docs/interop/ into modules/attestor/guides/; consolidated docs/observability/ (14 files + dashboards) into modules/telemetry/guides/ and dashboards/; consolidated docs/runtime/ into modules/scanner/guides/; consolidated docs/slo/ into modules/orchestrator/guides/; created modules/devportal/guides/; moved docs/evaluate/ to product/; moved docs/metrics/ to modules/telemetry/guides/ |
| 2026-01-06 | **Pass 3**: Consolidated docs/router/ into modules/router/ (archived 25 sprints to docs-archived/implplan/router/, moved transports/ and guides/); consolidated docs/reachability/ (23 files) into modules/reach-graph/guides/ and schemas/; consolidated docs/risk/ into modules/risk-engine/guides/ and samples/; consolidated docs/attestor/ and docs/provenance/ into respective modules; consolidated docs/vuln/ into modules/vuln-explorer/guides/; consolidated docs/sbom/ and docs/evidence-locker/ into respective modules; consolidated docs/marketing/ and docs/market/ into docs/product/ (strategy, competitive analysis); archived docs/artifacts/ to docs-archived/ |
| 2026-01-06 | **Pass 2**: Consolidated CLI docs into modules/cli/guides/ (removed docs/cli/); consolidated runbooks into operations/runbooks/ (removed docs/runbooks/); merged examples/ into samples/; consolidated signals/ into modules/signals/guides/; merged training/ into onboarding/ with concepts/ and faq/ subdirs; distributed guides/ into relevant module locations (risk-engine, signer, vex-lens, ui, authority); merged ci/ into cicd/; merged ops/ into operations/; moved faq/policy-faq.md to policy/faq.md |
| 2026-01-06 | Consolidated UI/Console docs into modules/ui/; consolidated deploy/deployment/install into operations/deployment/; consolidated docs/vex/ into modules/vex-lens/guides/; consolidated docs/release/ into docs/releases/; consolidated security docs (removed technical/security/) |
| 2026-01-05 | Created index; renamed module directories to kebab-case; updated CLAUDE.md with missing modules; fixed 80+ old numbered file references; consolidated docs/advisory-ai/ into docs/modules/advisory-ai/ |