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:
24
AGENTS.md
24
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
|
||||
|
||||
Reference in New Issue
Block a user