KNOWLEDGE.md — Project Knowledge Index¶
Central index of project architecture, decisions, and evolution. Principle: Index, don't duplicate — link to RF/HL files, don't copy their contents.
0. Philosophy & Principles¶
Core principles that guide all decisions. Each links to the HL/RF where it was formalized.
| # | Principle | Source |
|---|---|---|
| P1 | Describe your first principle | HL-{PREFIX}-{N} |
| P2 | Second principle | RF {PREFIX}-{N} |
1. Architecture Map¶
High-level view of the system's components and their relationships.
Components¶
| Component | Description | Key Files |
|---|---|---|
| API Server | Main backend | src/api/ |
| Frontend | Web UI | src/web/ |
Architecture Decisions¶
| # | Decision | Rationale | Source |
|---|---|---|---|
| D1 | e.g., Chose PostgreSQL over MongoDB | ACID compliance needed | RF {PREFIX}-{N} |
2. Key Artifacts¶
Most important task artifacts for understanding the project. Read these first.
| Task | Title | Key Artifact | Why Important |
|---|---|---|---|
| PROJ-1 | Initial setup | RF {PREFIX}-1 | Foundation decisions |
3. Legacy & Deprecation¶
What was dropped, frozen, or replaced — and why.
| Item | Status | When | Replacement | Source |
|---|---|---|---|---|
| e.g., Old auth module | Deprecated | 2026-01 | OAuth2 flow | RF {PREFIX}-{N} |
4. Project Facts¶
Index of verified project knowledge. Details in
knowledge/topic files. Updated by/tfw-knowledgeconsolidation.
| Category | Count | Topic File |
|---|---|---|
Maintenance: This file is updated via the
tfw-docsworkflow after each REVIEW. See.tfw/workflows/docs.mdfor the update process.