docs(src): Update documentation for src/ layout and sloppy.py entry point

This commit is contained in:
2026-03-04 10:10:41 -05:00
parent de6d2b0df6
commit ea5bb4eedf
5 changed files with 48 additions and 32 deletions

View File

@@ -37,7 +37,7 @@
- **psutil:** For system and process monitoring (CPU/Memory telemetry).
- **uv:** An extremely fast Python package and project manager.
- **pytest:** For unit and integration testing, leveraging custom fixtures for live GUI verification.
- **Taxonomy & Artifacts:** Enforces a clean root by redirecting session logs to `logs/sessions/`, sub-agent logs to `logs/agents/`, and error logs to `logs/errors/`. Temporary test data and test logs are siloed in `tests/artifacts/` and `tests/logs/`.
- **Taxonomy & Artifacts:** Enforces a clean root by organizing core implementation into a `src/` directory, and redirecting session logs to `logs/sessions/`, sub-agent logs to `logs/agents/`, and error logs to `logs/errors/`. Temporary test data and test logs are siloed in `tests/artifacts/` and `tests/logs/`.
- **ApiHookClient:** A dedicated IPC client for automated GUI interaction and state inspection.
- **mma-exec / mma.ps1:** Python-based execution engine and PowerShell wrapper for managing the 4-Tier MMA hierarchy and automated documentation mapping.
- **dag_engine.py:** A native Python utility implementing `TrackDAG` and `ExecutionEngine` for dependency resolution, cycle detection, transitive blocking propagation, and programmable task execution loops.

View File

@@ -17,14 +17,6 @@
- [x] Task: Conductor - User Manual Verification 'Phase 3: Entry Point & Import Resolution' (Checkpoint: 24f385e)
## Phase 4: Final Validation & Documentation
- [ ] Task: Full Test Suite Validation
- [ ] WHERE: Project root
- [ ] WHAT: Run `uv run pytest`. Fix any remaining path resolution issues for logs, artifacts, and configs.
- [ ] HOW: Verify 100% pass rate.
- [ ] SAFETY: Artifacts must still be written to `tests/artifacts/`.
- [ ] Task: Update Core Documentation
- [ ] WHERE: `Readme.md`, `docs/`, `conductor/tech-stack.md`
- [ ] WHAT: Document `sloppy.py` as the new entry point. Document the `src/` directory layout.
- [ ] HOW: Surgical text replacement.
- [ ] SAFETY: Accurate representation of new structure.
- [x] Task: Full Test Suite Validation
- [x] Task: Update Core Documentation
- [ ] Task: Conductor - User Manual Verification 'Phase 4: Final Validation & Documentation' (Protocol in workflow.md)