Skip to content

Commit 7dbbc80

Browse files
gHashTagclaude
andcommitted
docs: Add mandatory achievement documentation rules
Agents must now automatically document milestones: - Create reports in docsite/docs/research/ for major achievements - Update benchmarks for performance improvements - Build, deploy to gh-pages, commit and push Added to both AGENTS.md and CLAUDE.md: - Documentation workflow steps - Report template with required sections - Examples of documented achievements - Updated EXIT_SIGNAL to include achievement_documented 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 1571219 commit 7dbbc80

2 files changed

Lines changed: 166 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,14 +272,127 @@ cd trinity/output && for f in *.zig; do zig test "$f"; done # Test all
272272

273273
---
274274

275+
## 📝 MANDATORY: DOCUMENT ACHIEVEMENTS
276+
277+
After completing ANY significant milestone, agents MUST automatically document it:
278+
279+
### What Requires Documentation
280+
281+
| Achievement Type | Action Required |
282+
|-----------------|-----------------|
283+
| New feature working | Create `docsite/docs/research/<feature>-report.md` |
284+
| Benchmark improvement | Update `docsite/docs/benchmarks/` |
285+
| Integration success | Create research report with metrics |
286+
| Node/inference milestone | Document in research section |
287+
| Performance breakthrough | Add to benchmarks with proof |
288+
289+
### Documentation Workflow (MANDATORY)
290+
291+
```bash
292+
# 1. CREATE report in docsite
293+
# File: docsite/docs/research/<milestone>-report.md
294+
295+
---
296+
sidebar_position: N
297+
---
298+
299+
# <Milestone> Report
300+
301+
**Date:** YYYY-MM-DD
302+
**Status:** Production-ready / In Progress
303+
304+
## Key Metrics
305+
| Metric | Value | Status |
306+
|--------|-------|--------|
307+
| ... | ... | ... |
308+
309+
## What This Means
310+
- For users: ...
311+
- For node operators: ...
312+
- For investors: ...
313+
314+
## Technical Details
315+
...
316+
317+
# 2. UPDATE sidebar
318+
# File: docsite/sidebars.ts
319+
# Add new page to appropriate category
320+
321+
# 3. BUILD & DEPLOY
322+
cd docsite && npm run build
323+
USE_SSH=true npm run deploy
324+
325+
# 4. COMMIT & PUSH
326+
git add docsite/
327+
git commit -m "docs: Add <milestone> report"
328+
git push
329+
```
330+
331+
### Report Template
332+
333+
```markdown
334+
---
335+
sidebar_position: N
336+
---
337+
338+
# <Feature/Milestone> Report
339+
340+
**Date:** February X, 2026
341+
**Status:** Production-ready
342+
343+
## Executive Summary
344+
One paragraph summary of achievement.
345+
346+
## Key Metrics
347+
348+
| Metric | Value | Status |
349+
|--------|-------|--------|
350+
| Coherence | X% | Verified |
351+
| Speed | X tok/s | CPU/GPU |
352+
| Cost | $X/hr | vs $Y cloud |
353+
354+
## What This Means
355+
356+
### For Users
357+
- Benefit 1
358+
- Benefit 2
359+
360+
### For Node Operators
361+
- $TRI earning potential
362+
363+
### For Investors
364+
- Proof of technology
365+
366+
## Technical Details
367+
Architecture, implementation, test results.
368+
369+
## Conclusion
370+
Summary and next steps.
371+
372+
---
373+
**Formula:** phi^2 + 1/phi^2 = 3
374+
```
375+
376+
### Examples of Documented Achievements
377+
378+
| Achievement | Report Location |
379+
|-------------|-----------------|
380+
| BitNet coherence testing | `/docs/research/bitnet-report` |
381+
| Trinity Node FFI integration | `/docs/research/trinity-node-ffi` |
382+
| Competitor comparison | `/docs/benchmarks/competitor-comparison` |
383+
| GPU inference benchmarks | `/docs/benchmarks/gpu-inference` |
384+
385+
---
386+
275387
## 🏆 EXIT_SIGNAL
276388

277389
Agent must continue iterations until:
278390
1. All tests pass
279391
2. Specification is complete
280392
3. TOXIC VERDICT is written
281393
4. TECH TREE SELECT is proposed
282-
5. Changes are committed
394+
5. **Achievement documented** (if milestone reached)
395+
6. Changes are committed
283396

284397
```yaml
285398
EXIT_SIGNAL = (

CLAUDE.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,12 +247,64 @@ EXIT_SIGNAL = (
247247
spec_complete AND
248248
critical_assessment_written AND
249249
tech_tree_options_proposed AND
250+
achievement_documented AND
250251
committed
251252
)
252253
```
253254

254255
---
255256

257+
## Mandatory Achievement Documentation
258+
259+
When completing significant milestones, AUTOMATICALLY document them:
260+
261+
### What Requires Documentation
262+
263+
| Type | Location | Action |
264+
|------|----------|--------|
265+
| Feature integration | `docsite/docs/research/` | Create report |
266+
| Benchmark improvement | `docsite/docs/benchmarks/` | Update metrics |
267+
| Node milestone | `docsite/docs/research/` | Create report |
268+
| Performance proof | `docsite/docs/benchmarks/` | Add data |
269+
270+
### Documentation Steps (ALWAYS DO)
271+
272+
```bash
273+
# 1. Create report
274+
# docsite/docs/research/<milestone>-report.md
275+
276+
# 2. Update sidebars.ts
277+
# Add entry to appropriate category
278+
279+
# 3. Build & deploy
280+
cd docsite && npm run build
281+
USE_SSH=true npm run deploy
282+
283+
# 4. Commit & push
284+
git add docsite/
285+
git commit -m "docs: Add <milestone> report"
286+
git push
287+
```
288+
289+
### Required Report Sections
290+
291+
| Section | Content |
292+
|---------|---------|
293+
| Key Metrics | Table with values, status |
294+
| What This Means | For users, operators, investors |
295+
| Technical Details | Architecture, implementation |
296+
| Conclusion | Summary, next steps |
297+
298+
### Live Documentation
299+
300+
| Page | URL |
301+
|------|-----|
302+
| Research | https://gHashTag.github.io/trinity/docs/research |
303+
| Benchmarks | https://gHashTag.github.io/trinity/docs/benchmarks |
304+
| API Reference | https://gHashTag.github.io/trinity/docs/api |
305+
306+
---
307+
256308
## Ralph Autonomous Development
257309

258310
Ralph enables continuous autonomous development cycles for Claude Code.

0 commit comments

Comments
 (0)