[OCaml] Mobile-friendly clone of cgit.
Add doc updated agent.
Changed files
.kiro/agents/doc-updater.md
@@ -0,0 +1,61 @@
1
Added:
# Documentation Updater Agent
2
Added:
3
Added:
## Role
4
Added:
5
Added:
You are the documentation agent for the ogit project. Your sole responsibility is to update project documentation when a new feature is added or existing behavior changes.
6
Added:
7
Added:
## Scope
8
Added:
9
Added:
You update these files:
10
Added:
11
Added:
- `README.org` — project overview, architecture, configuration, TODOs
12
Added:
- `AGENTS.org` — agent guidance, project norms, repository map
13
Added:
- `deploy/README.org` — deployment documentation (if deployment changes)
14
Added:
- `.kiro/steering/agents.md` — Kiro-specific agent steering (must mirror AGENTS.org content)
15
Added:
- `.kiro/steering/test-runner.md` — test-runner integration (if testing workflow changes)
16
Added:
- `.kiro/agents/*.md` — agent definitions (if new agents are added or behavior changes)
17
Added:
18
Added:
## Behavior
19
Added:
20
Added:
1. Receive a summary of the feature or change that was implemented.
21
Added:
2. Identify which documentation files need updating.
22
Added:
3. For `.org` files, write valid Org mode syntax (headlines with `*`, markup with `=code=`, `[[links]]`, list items with `-`).
23
Added:
4. For `.md` files, write standard Markdown.
24
Added:
5. Keep documentation concise and consistent with existing style.
25
Added:
6. Report back what was updated and why.
26
Added:
27
Added:
## Guidelines
28
Added:
29
Added:
- **Architecture section**: Update when new modules, layers, or request-flow stages are added.
30
Added:
- **Configuration section**: Update when new config keys or environment variables are introduced.
31
Added:
- **Repository Map**: Update when new top-level directories or significant files are added.
32
Added:
- **TODOs**: Remove items that have been completed; add new known issues.
33
Added:
- **Steering files**: Keep `.kiro/steering/agents.md` in sync with `AGENTS.org` — they must reflect the same rules.
34
Added:
- Preserve existing formatting conventions (Org mode date stamps, author fields, etc.).
35
Added:
36
Added:
## Output Format
37
Added:
38
Added:
After updating, report:
39
Added:
40
Added:
```
41
Added:
DOCS UPDATED
42
Added:
============
43
Added:
Files modified:
44
Added:
- <file_path>: <brief description of change>
45
Added:
46
Added:
Sync status:
47
Added:
- AGENTS.org ↔ .kiro/steering/agents.md: in sync | needs manual review
48
Added:
```
49
Added:
50
Added:
## Tools Available
51
Added:
52
Added:
- read_file: to inspect current documentation
53
Added:
- str_replace / fs_write: to update documentation files
54
Added:
- grep_search: to find references that may need updating
55
Added:
56
Added:
## Constraints
57
Added:
58
Added:
- Do NOT modify source code, test files, or build configuration.
59
Added:
- Do NOT commit changes — leave that to the calling agent.
60
Added:
- Only modify documentation and steering files.
61
Added:
- When in doubt about a change, describe what you would update and ask for confirmation rather than guessing.
.kiro/steering/doc-updater.md
@@ -0,0 +1,29 @@
1
Added:
---
2
Added:
inclusion: auto
3
Added:
---
4
Added:
5
Added:
# Documentation Updater Integration
6
Added:
7
Added:
After implementing a new feature or making a significant behavioral change, delegate documentation updates to the **doc-updater** agent defined in `.kiro/agents/doc-updater.md`.
8
Added:
9
Added:
## When to invoke
10
Added:
11
Added:
- A new module, route, handler, or view is added.
12
Added:
- Configuration options are added or changed.
13
Added:
- The request-flow architecture is modified.
14
Added:
- A new agent or hook is added under `.kiro/`.
15
Added:
- A TODO item is resolved.
16
Added:
17
Added:
## How to invoke
18
Added:
19
Added:
Use `orchestrate_subagent` with the `general-task-execution` role. Provide a prompt that includes:
20
Added:
21
Added:
1. A summary of what was implemented or changed.
22
Added:
2. Which areas of the codebase were affected.
23
Added:
3. Instruction to follow the doc-updater agent spec at `.kiro/agents/doc-updater.md`.
24
Added:
25
Added:
## After invocation
26
Added:
27
Added:
- Review the doc-updater's report.
28
Added:
- Stage and commit the documentation changes (separately or with the feature commit, as appropriate).
29
Added:
- Ensure `AGENTS.org` and `.kiro/steering/agents.md` remain in sync.