docs: update README.md and AGENTS.md for new files

Update documentation to reflect new project structure
and files created for test coverage enhancement.

README.md:
- Add STATUS.md link to documentation table
- Add JOURNAL.md link to documentation table
- STATUS.md: Manager-facing status report
- JOURNAL.md: AI agent memory and ADRs

AGENTS.md:
- Document STATUS.md purpose and maintenance
- Document JOURNAL.md purpose (AI memory, ADRs)
- Add tests/system/ directory to project structure
- Clean up obsolete file references
- Update documentation structure section

These changes ensure all team members (human and AI)
understand the purpose and location of key files.

💘 Generated with Crush

Assisted-by: GLM-5 via Crush <crush@charm.land>
This commit is contained in:
Charles N Wyble
2026-02-17 10:12:20 -05:00
parent d00f3c9f02
commit b3d02d0c14
2 changed files with 33 additions and 7 deletions

View File

@@ -132,16 +132,36 @@
├── PRD.md # Product Requirements Document
├── README.md # Project documentation
├── AGENTS.md # THIS FILE - Agent guidelines
├── RESUME.md # Session resumption guide
├── JOURNAL.md # Append-only development journal
├── BUILD-COMPLETE.md # Build completion report
├── BUILD-SUMMARY.md # Build session summary
├── VERIFICATION-REPORT.md # Comprehensive verification report
├── QUICK_START.md # Quick reference commands
├── SESSION-CLOSED.md # Session closure documentation
├── STATUS.md # Manager status report (quick-glance)
├── JOURNAL.md # AI memory - ADRs, insights, lessons (append-only)
└── .gitignore # Git ignore patterns
```
### Documentation Files
```
├── 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)
└── docs/ # Detailed documentation
├── TEST-COVERAGE.md # Test suite coverage
├── VERIFICATION-REPORT.md # Compliance verification
├── COMPLIANCE.md # Compliance standards
└── security-model.md # Security architecture
```
**STATUS.md Purpose**:
- Quick-glance project status for managers
- What's working, what's broken, current blockers
- Next actions and metrics
- Maintained by AI agent, read by humans
**JOURNAL.md Purpose**:
- Long-term memory for AI agents
- Architectural Decision Records (ADRs)
- Patterns observed, lessons learned
- APPEND-ONLY - never modify existing entries
### Source Code
```
src/
@@ -185,6 +205,10 @@ tests/
│ └── config_test.bats
├── security/ # Security compliance tests
│ └── compliance_test.bats
├── system/ # System/runtime tests (VM boot, FDE, Secure Boot)
│ ├── boot_test.bats
│ ├── secureboot_test.bats
│ └── fde_test.bats
├── test_helper/ # Test utilities
│ └── common.bash
└── simple_test.bats # Basic bats test

View File

@@ -10,6 +10,8 @@
### 📋 Documentation Files
| File | Purpose |
|------|---------|
| **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/TEST-COVERAGE.md** | Test suite details and coverage |