From f13bb8577abaec92be762cc9632c7cfc9272adb5 Mon Sep 17 00:00:00 2001 From: Charles N Wyble Date: Thu, 19 Feb 2026 14:52:56 -0500 Subject: [PATCH] docs: move PRD.md and SDLC.md to docs/ subdirectory MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- AGENTS.md | 24 +++++++++++++----------- README.md | 19 ++++++++++++------- PRD.md => docs/PRD.md | 0 SDLC.md => docs/SDLC.md | 0 4 files changed, 25 insertions(+), 18 deletions(-) rename PRD.md => docs/PRD.md (100%) rename SDLC.md => docs/SDLC.md (100%) diff --git a/AGENTS.md b/AGENTS.md index 27f06ca..7e7e279 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -128,7 +128,6 @@ / ├── run.sh # MAIN ENTRY POINT - All operations (build/test/lint/iso/monitor/VM) ├── Dockerfile # Multi-stage build environment -├── PRD.md # Product Requirements Document ├── README.md # Project documentation ├── AGENTS.md # THIS FILE - Agent guidelines ├── STATUS.md # Manager status report (quick-glance) @@ -140,10 +139,10 @@ ``` ├── STATUS.md # Manager report - current status, blockers, next actions ├── JOURNAL.md # AI memory - ADRs, patterns, lessons learned -├── PRD.md # Product requirements ├── AGENTS.md # Agent guidelines (START HERE) -├── SDLC.md # Software Development Lifecycle (READ THIS) └── docs/ # Detailed documentation + ├── PRD.md # Product Requirements Document + ├── SDLC.md # Software Development Lifecycle (READ THIS) ├── TEST-COVERAGE.md # Test suite coverage ├── VERIFICATION-REPORT.md # Compliance verification ├── COMPLIANCE.md # Compliance standards @@ -242,8 +241,8 @@ git log --oneline -10 #### 2. UNDERSTAND REQUIREMENTS - Read MANDATORY SECURITY REQUIREMENTS (above) -- Review PRD.md for detailed requirements -- Read SDLC.md for development workflow (CRITICAL) +- Review docs/PRD.md for detailed requirements +- Read docs/SDLC.md for development workflow (CRITICAL) - Check AGENTS.md for critical constraints - Understand Docker-only workflow @@ -462,9 +461,10 @@ Container Side Host Side Purpose ### Quick Reference - **AGENTS.md** - THIS FILE - Start here - **README.md** - Project overview and quick commands -- **PRD.md** - Product Requirements Document (detailed) +- **docs/PRD.md** - Product Requirements Document (detailed) ### Detailed Documentation (docs/) +- **docs/SDLC.md** - Software Development Lifecycle - **docs/TEST-COVERAGE.md** - Test suite coverage and details - **docs/VERIFICATION-REPORT.md** - Verification and compliance report - **docs/COMPLIANCE.md** - Compliance standards and requirements @@ -526,7 +526,8 @@ Container Side Host Side Purpose ### Before Making Changes 1. **Read relevant documentation**: - AGENTS.md (this file) - For agent guidelines - - PRD.md - For requirements + - docs/PRD.md - For requirements + - docs/SDLC.md - For development workflow - README.md - For quick commands - docs/TEST-COVERAGE.md - For test details - docs/VERIFICATION-REPORT.md - For verification results @@ -630,10 +631,11 @@ Before marking work complete: ### Check These First 1. **AGENTS.md** - This file 2. **README.md** - Quick commands -3. **PRD.md** - Requirements -4. **docs/TEST-COVERAGE.md** - Test details -5. **docs/VERIFICATION-REPORT.md** - Verification results -5. **JOURNAL.md** - Session history +3. **docs/PRD.md** - Requirements +4. **docs/SDLC.md** - Development workflow +5. **docs/TEST-COVERAGE.md** - Test details +6. **docs/VERIFICATION-REPORT.md** - Verification results +7. **JOURNAL.md** - Session history ### Debug Mode ```bash diff --git a/README.md b/README.md index c873b88..2d5dc4e 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/PRD.md b/docs/PRD.md similarity index 100% rename from PRD.md rename to docs/PRD.md diff --git a/SDLC.md b/docs/SDLC.md similarity index 100% rename from SDLC.md rename to docs/SDLC.md