Initial commit

docs/README.md

@@ -0,0 +1,67 @@
+# Stella Ops
+
+> **Self‑hosted, SBOM‑first DevSecOps platform – offline‑friendly, AGPL‑3.0, free up to {{ quota_token }} scans per UTC day (soft delay only, never blocks).**
+
+Stella Ops lets you discover container vulnerabilities in **< 5 s** without sending a single byte outside your network.  
+Everything here is open‑source and versioned — when you check out a git tag, the docs match the code you are running.
+
+---
+
+## 🚀 Start here (first 60 minutes)
+
+| Step | What you will learn | Doc |
+|------|--------------------|-----|
+| 1 ️⃣ | 90‑second elevator pitch & pillars | **[What Is Stella Ops?](01_WHAT_IS_IT.md)** |
+| 2 ️⃣ | Pain points it solves | **[Why Does It Exist?](02_WHY.md)** |
+| 3 ️⃣ | Install & run a scan in 10 min | **[Install Guide](21_INSTALL_GUIDE.md)** |
+| 4 ️⃣ | Components & data‑flow | **[High‑Level Architecture](07_HIGH_LEVEL_ARCHITECTURE.md)** |
+| 5 ️⃣ | Integrate the CLI / REST API | **[API & CLI Reference](09_API_CLI_REFERENCE.md)** |
+| 6 ️⃣ | Vocabulary used throughout the docs | **[Glossary](14_GLOSSARY_OF_TERMS.md)** |
+
+---
+
+## 📚 Complete Table of Contents
+
+<details>
+<summary>Click to expand the full docs index</summary>
+
+### Overview
+- **01 – [What Is Stella Ops?](01_WHAT_IS_IT.md)**
+- **02 – [Why Does It Exist?](02_WHY.md)**
+- **03 – [Vision & Road‑map](03_VISION.md)**
+- **04 – [Feature Matrix](04_FEATURE_MATRIX.md)**
+
+### Reference & concepts
+- **05 – [System Requirements Specification](05_SYSTEM_REQUIREMENTS_SPEC.md)**
+- **07 – [High‑Level Architecture](40_ARCHITECTURE_OVERVIEW.md)**
+- **08 – Module Specifications**  
+  - [README](08_MODULE_SPECIFICATIONS/README.md)  
+  - [`backend_api.md`](08_MODULE_SPECIFICATIONS/backend_api.md)  
+  - [`zastava_scanner.md`](08_MODULE_SPECIFICATIONS/zastava_scanner.md)  
+  - [`registry_scanner.md`](08_MODULE_SPECIFICATIONS/registry_scanner.md)  
+  - [`nightly_scheduler.md`](08_MODULE_SPECIFICATIONS/nightly_scheduler.md)
+- **09 – [API & CLI Reference](09_API_CLI_REFERENCE.md)**
+- **10 – [Plug‑in SDK Guide](10_PLUGIN_SDK_GUIDE.md)**
+- **11 – [Data Schemas](11_DATA_SCHEMAS.md)**
+- **12 – [Performance Workbook](12_PERFORMANCE_WORKBOOK.md)**
+- **13 – [Release‑Engineering Playbook](13_RELEASE_ENGINEERING_PLAYBOOK.md)**
+
+### User & operator guides
+- **14 – [Glossary](14_GLOSSARY_OF_TERMS.md)**
+- **15 – [UI Guide](15_UI_GUIDE.md)**
+- **17 – [Security Hardening Guide](17_SECURITY_HARDENING_GUIDE.md)**
+- **18 – [Coding Standards](18_CODING_STANDARDS.md)**
+- **19 – [Test‑Suite Overview](19_TEST_SUITE_OVERVIEW.md)**
+- **21 – [Install Guide](21_INSTALL_GUIDE.md)**
+- **22 – [CI/CD Recipes Library](ci/20_CI_RECIPES.md)**
+- **23 – [FAQ](23_FAQ_MATRIX.md)**
+- **24 – [Offline Update Kit Admin Guide](24_OUK_ADMIN_GUIDE.md)**
+
+### Legal & licence
+- **29 – [Legal & Quota FAQ](29_LEGAL_FAQ_QUOTA.md)**
+
+</details>
+
+---
+
+© 2025 Stella Ops contributors – licensed AGPL‑3.0‑or‑later