docs: move PRD.md and SDLC.md to docs/ subdirectory

Consolidate all documentation files under docs/ directory.
Update AGENTS.md and README.md to reflect new file locations.

💘 Generated with Crush

Assisted-by: GLM-5 via Crush <crush@charm.land>
This commit is contained in:
Charles N Wyble
2026-02-19 14:52:56 -05:00
parent a284b095d8
commit f13bb8577a
4 changed files with 25 additions and 18 deletions

View File

@@ -4,7 +4,7 @@
### 🚀 Quick Start
1. **AGENTS.md** - Current status + critical requirements (START HERE)
2. **PRD.md** - Product Requirements Document
2. **docs/PRD.md** - Product Requirements Document
3. **README.md** - This file (project overview)
### 📋 Documentation Files
@@ -13,7 +13,8 @@
| **STATUS.md** | 📊 Project status report (manager quick-glance) |
| **JOURNAL.md** | 📝 AI memory, ADRs, lessons learned (append-only) |
| **AGENTS.md** | ⚡ START HERE - Current status + requirements |
| **PRD.md** | Complete product requirements |
| **docs/PRD.md** | Complete product requirements |
| **docs/SDLC.md** | Software Development Lifecycle |
| **docs/TEST-COVERAGE.md** | Test suite details and coverage |
| **docs/VERIFICATION-REPORT.md** | Security compliance verification |
@@ -139,7 +140,8 @@ Build KNEL-Football secure ISO with Docker-only workflow following AGENTS.md req
README.md (Main Entry Point)
├── ⚠️ READ THESE FILES FIRST
│ ├── AGENTS.md (START HERE - Current Status)
│ ├── PRD.md (Requirements)
│ ├── docs/PRD.md (Requirements)
│ ├── docs/SDLC.md (Development Workflow)
│ ├── docs/TEST-COVERAGE.md (Test Details)
│ └── docs/VERIFICATION-REPORT.md (Verification Results)
├── Quick Commands
@@ -157,7 +159,6 @@ README.md (Main Entry Point)
football/
├── AGENTS.md # START HERE - Agent guidelines
├── README.md # This file
├── PRD.md # Product Requirements
├── Dockerfile # Build environment
├── run.sh # Main entry point
├── config/ # Live-build configuration
@@ -177,6 +178,8 @@ football/
│ ├── security/ # Security compliance tests
│ └── test_helper/ # Test utilities
├── docs/ # Detailed documentation
│ ├── PRD.md # Product Requirements
│ ├── SDLC.md # Software Development Lifecycle
│ ├── TEST-COVERAGE.md
│ └── VERIFICATION-REPORT.md
├── output/ # ISO artifacts (ISO, checksums)
@@ -191,8 +194,9 @@ football/
**Before Making Changes**:
1. Read AGENTS.md (current status, requirements)
2. Read PRD.md (detailed requirements)
3. Review docs/TEST-COVERAGE.md (test details)
2. Read docs/PRD.md (detailed requirements)
3. Read docs/SDLC.md (development workflow)
4. Review docs/TEST-COVERAGE.md (test details)
**Making Changes**:
1. Read files before editing (Critical!)
@@ -320,6 +324,7 @@ License: GNU Affero General Public License v3.0 only
**For detailed information, see:**
- AGENTS.md (START HERE)
- PRD.md (Requirements)
- docs/PRD.md (Requirements)
- docs/SDLC.md (Development Workflow)
- docs/TEST-COVERAGE.md (Tests)
- docs/VERIFICATION-REPORT.md (Compliance)