Single Source of Truth (SSOT) for the SafeChord Ecosystem.
This repository serves as the central knowledge base for the SafeChord project. It adopts the Knowledge-Driven Development (KDD) methodology, treating documentation not just as a reference, but as the executable specification (Prompt Code) that drives AI Agents (Gemini, Cline) to generate code and infrastructure configurations.
SafeChord uses a Twin-Repo Strategy plus a dedicated PaaS layer. This documentation hub connects them all:
| Repository | Role | Description |
|---|---|---|
| 🟦 SafeZone | Application | The microservices source code, business logic, and data pipelines (Kafka/FastAPI). |
| 🟨 SafeZone-Deploy | Delivery | Helm Umbrella Charts and GitOps configurations for Preview/Staging environments. |
| 🟥 Chorde | Platform | The underlying Kubernetes (K3s) clusters and platform services (DB, MQ). |
| ⬜ Docs | Knowledge | (You are here) The master plan, security policies, and architectural specs. |
Before writing any code, we define it here.
- 🗺️ Knowledge Map (Start Here): The global navigation guide to all documents.
- 🛡️ Security Architecture: The "Constitution" of the project—SecretOps, RBAC, and Network Policies.
- 🌍 Environment Evolution: Understanding the "Trinity" (Local -> Preview -> Staging).
- 🤖 KDD Methodology: How we collaborate with AI Agents.
This site is built with MkDocs Material. You can run it locally to browse the knowledge graph.
pip install mkdocs-materialmkdocs serveOpen http://127.0.0.1:8000 in your browser.
We follow a strict "Doc-First" policy driven by KDD:
- Update the Spec: Before changing any code in
SafeZoneorSafeZone-Deploy, update the corresponding specification file indocs/. - Align with AI: Use these documents as the context prompt for your AI coding assistant.
- Verify: Ensure
safechord.knowledgetree.mdaccurately reflects the new structure.
For detailed collaboration rules, please read KDD Practice.
This project is licensed under the MIT License.