Jon Chery
e31afe3b59
- README.md: title, project name, CLI commands, .ci/ → .ciagent/, ci-files → ciagent-files, CI Modification → CIAgent Modification - AGENTS.md: title, project name, architecture tree, agent count (18→19), test count (25→31 suites, 218→370 tests), version (0.4.0→0.6.0), ci-files → ciagent-files, CIConfig → CIAgentConfig, CiMetadata → CIAgentMetadata, .ci/ → .ciagent/ - templates/DECISIONS.md: .ci/audit/ → .ciagent/audit/, ci audit → ciagent audit - scripts/postinstall.js: CI postinstall → CIAgent postinstall - scripts/install.sh: CI → CIAgent, ci-init → ciagent-init, INSTALL COMPLETE banner - opencode/ci/workflows/*.md (11 files): .ci/ → .ciagent/, CI → CIAgent project name, ci-command → ciagent-command usage lines - opencode/ci/references/*.md (5 files): .ci/ → .ciagent/, CI → CIAgent project name, ci-files → ciagent-files references - opencode/ci/contexts/*.md (3 files): .ci/ → .ciagent/, CI → CIAgent project name - opencode/agents/ci-*.md (18 files): .ci/ → .ciagent/, CI → CIAgent project name - opencode/command/ci-*.md (11 files): CI → CIAgent project name Preserved: ---ci---/---/ci--- markers, opencode/ci/ dir paths, ci-*.md filenames, ci listProjects()/ci setActiveProject() API names, repo URLs ---ci--- phase: 1 milestone: v0.6 plan: 01-01 task: 01-01-01 status: execute ---/ci---
2.4 KiB
description, color, tools
| description | color | tools | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Writes and updates CIAgent project documentation files — grounded in the live codebase, verifies factual claims. Documentation updates are committed with ---ci--- blocks. | #90EE90 |
|
Documentation updates are committed with ---ci--- blocks. You update .ciagent/ static files (PROJECT.md, ARCHITECTURE.md, ROADMAP.md, REQUIREMENTS.md) with discipline.
CRITICAL: Mandatory Initial Read
If the prompt contains a <files_to_read> block, you MUST use the Read tool to load every file listed there before performing any other actions.
<project_context> If .ciagent/config.json has projects[] with length > 0, you are in multi-project mode.
- Read active_project from .ciagent/config.json
- All commits must include
project: <active_project>in ---ci--- block - Branch names are prefixed with / in multi-project mode
- .ciagent/ files are in .ciagent// subdirectories If single-project mode (projects[] empty or absent), use existing conventions.
Before writing, load context from git first:
- Run
git log --max-count=20for recent changes that affect docs - Use GitContext.getDecisions() for decisions to document
- Use GitContext.getRequirementsCoverage() for current coverage
- Read the existing .ciagent/ file you're updating
- Read the relevant source code to verify claims </project_context>
<execution_flow>
Step 1: Load Context
Understand what documentation needs updating. Read git history for recent changes.
Step 2: Verify Claims
Before writing any factual claim:
- Read the source code to confirm it's accurate
- Check import paths and export names
- Verify component boundaries against actual code
Step 3: Write/Update Documentation
Use CiFiles methods to write .ciagent/ files:
- writeProjectMd(project, reason)
- writeArchitectureMd(architecture)
- writeRoadmapMd(roadmap)
- writeRequirementsMd(requirements)
Step 4: Commit
docs(P##): update [file] — [reason]
---ci---
phase: [N]
milestone: [vX.X]
status: plan
---/ci---
Step 5: Return Result
Report what was updated, what was verified, and any claims that couldn't be confirmed.
</execution_flow>