Refactor: rename framework files to dot-prefixed lowercase, fix onboarding references, validate VRAM detection

- Rename AGENT.md -> .agent.md, RULES.md -> .rules.md, ONBOARDING.md -> .onboarding.md
- Rename BUG_REPORT.md -> .bug_report.md, ADVERSARIAL_BUG_REPORT.md -> .adversarial_bug_report.md, VERDICT.md -> .verdict.md
- Fix onboarding.md references to use new .onboarding.md path
- Fix stop-hook-pattern.md reference to use .onboarding.md
- Update README.md, config.md, install.sh, update.sh, prompts/*, references/*
- VRAM detection script validated and working
This commit is contained in:
2026-06-12 12:40:15 -04:00
parent c629661b28
commit 502f47eb21
22 changed files with 150 additions and 150 deletions
+17 -17
View File
@@ -5,10 +5,10 @@ Your only job is to take a completed SPEC.md and break it into the smallest poss
## Read These Files
1. {project}/tasks/{task-name}/SPEC.md
2. {project}/.agent-framework/RULES.md (if exists — project override) OR ~/.agent-framework/RULES.md (global default) — project-specific rules
3. ~/.agent-framework/config.md — Global framework configuration (VRAM, model settings)
4. {project}/.agent-framework/AGENT.md (if exists — project override) OR ~/.agent-framework/AGENT.md (global default) — project agent config
5. {project}/.agent-framework/scripts/vram_detect.sh (if exists — project override) OR ~/.agent-framework/scripts/vram_detect.sh (global default) — VRAM detection
2. {project}/.automaton/.rules.md (if exists — project override) OR ~/.automaton/.rules.md (global default) — project-specific rules
3. ~/.automaton/config.md — Global framework configuration (VRAM, model settings)
4. {project}/.automaton/.agent.md (if exists — project override) OR ~/.automaton/.agent.md (global default) — project agent config
5. {project}/.automaton/scripts/vram_detect.sh (if exists — project override) OR ~/.automaton/scripts/vram_detect.sh (global default) — VRAM detection
## Task
@@ -42,9 +42,9 @@ Each sub-task must fit within the target VRAM context window. Estimate the total
During a sub-task's lifecycle, the following files are loaded into context at various phases:
- **Research phase**: RULES.md + AGENT.md + task description
- **Design phase**: SPEC.md + RULES.md
- **Implement phase**: SPEC.md + DESIGN.md + TEST_PLAN.md + RULES.md + AGENT.md + CONTRACT.md
- **Research phase**: .rules.md + .agent.md + task description
- **Design phase**: SPEC.md + .rules.md
- **Implement phase**: SPEC.md + DESIGN.md + TEST_PLAN.md + .rules.md + .agent.md + CONTRACT.md
- **Bug Find phase**: SPEC.md + code (limited scope)
- **Adversarial Bug Find phase**: SPEC.md + code (limited scope)
- **Doc Review phase**: DESIGN.md
@@ -65,13 +65,13 @@ If a sub-task's estimated context exceeds the limit, break it into smaller sub-t
- A SPEC.md with 5 requirements, each with 2-3 acceptance criteria, is typically 500-1000 tokens
- A DESIGN.md with 3 sections and 5-10 bullet points is typically 1000-3000 tokens
- A TEST_PLAN.md with 5-10 test cases is typically 1000-2000 tokens
- RULES.md is typically 200-1000 tokens (varies per project)
- AGENT.md is typically 300-1000 tokens
- .rules.md is typically 200-1000 tokens (varies per project)
- .agent.md is typically 300-1000 tokens
- A CONTRACT.md is typically 200-500 tokens
**Quick estimate formula:**
```
Peak context ≈ SPEC.md tokens + DESIGN.md tokens + TEST_PLAN.md tokens + RULES.md tokens + AGENT.md tokens + CONTRACT.md tokens
Peak context ≈ SPEC.md tokens + DESIGN.md tokens + TEST_PLAN.md tokens + .rules.md tokens + .agent.md tokens + CONTRACT.md tokens
```
### Rule 7: Sub-Task Size Targets
@@ -97,12 +97,12 @@ Before decomposing, analyze the SPEC.md:
5. Identify configuration changes
6. Estimate the token budget for the full task (sum of all requirements' SPEC + DESIGN + TEST files)
7. **Detect VRAM limits**:
- Check `~/.agent-framework/config.md` for VRAM Configuration section
- If `Auto-detect: Yes`, run `{project}/.agent-framework/scripts/vram_detect.sh` to probe GPU VRAM, RAM, and model context window
- Check `~/.automaton/config.md` for VRAM Configuration section
- If `Auto-detect: Yes`, run `{project}/.automaton/scripts/vram_detect.sh` to probe GPU VRAM, RAM, and model context window
- If `Auto-detect: No`, use the manually specified values from config.md
- Report the detected VRAM limits
8. **Detect model context window**:
- Check `~/.agent-framework/config.md` for Model Configuration section
- Check `~/.automaton/config.md` for Model Configuration section
- If `Model: auto`, run the detection script to detect the model name and its context window
- If `Override context window: auto`, use the detected context window
- If both are specified, use the specified values
@@ -193,8 +193,8 @@ Produce a file called DECOMPOSITION.md at {project}/tasks/{task-name}/DECOMPOSIT
- SPEC.md: ~{x} tokens
- DESIGN.md: ~{x} tokens
- TEST_PLAN.md: ~{x} tokens
- RULES.md: ~{x} tokens
- AGENT.md: ~{x} tokens
- .rules.md: ~{x} tokens
- .agent.md: ~{x} tokens
- CONTRACT.md: ~{x} tokens
- **Peak context (Implement phase)**: ~{peak} tokens
- **Fits within VRAM**: Yes
@@ -210,8 +210,8 @@ Produce a file called DECOMPOSITION.md at {project}/tasks/{task-name}/DECOMPOSIT
- SPEC.md: ~{x} tokens
- DESIGN.md: ~{x} tokens
- TEST_PLAN.md: ~{x} tokens
- RULES.md: ~{x} tokens
- AGENT.md: ~{x} tokens
- .rules.md: ~{x} tokens
- .agent.md: ~{x} tokens
- CONTRACT.md: ~{x} tokens
- **Peak context (Implement phase)**: ~{peak} tokens
- **Fits within VRAM**: Yes