-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
| Area | Issue | File(s) |
|---|---|---|
| Architecture tree | src/tools/edit_wiki_page.rs exists but is not listed in the directory tree |
.github/copilot-instructions.md |
| Safe Output Tools | edit-wiki-page tool is fully implemented and wired up but has zero documentation |
src/tools/edit_wiki_page.rs, src/execute.rs, src/mcp.rs |
Details
1. Architecture tree missing edit_wiki_page.rs
The src/tools/ listing in the Architecture section shows:
βββ tools/
β βββ mod.rs
β βββ create_pr.rs
β βββ create_work_item.rs
β βββ memory.rs
β βββ missing_data.rs
β βββ missing_tool.rs
β βββ noop.rs
β βββ result.rs
But src/tools/edit_wiki_page.rs exists and is exported from src/tools/mod.rs (line 14: mod edit_wiki_page;, line 23: pub use edit_wiki_page::*;).
2. edit-wiki-page tool entirely absent from Safe Output Tools documentation
The tool is fully implemented:
src/tools/edit_wiki_page.rsβ agent params, config struct, executorsrc/execute.rsβ handles"edit-wiki-page"in Stage 2 (lines 185β190)src/mcp.rsβ exposes the tool via MCP server (lines 408β433)
The tool has the following interface (currently undocumented):
Agent parameters:
pathβ Wiki page path to update (e.g./Overview/Architecture). Must not contain...contentβ Markdown content for the wiki page (at least 10 characters).comment(optional) β Commit comment; falls back to front matter config or"Updated by agent".
Configuration options (front matter):
safe-outputs:
edit-wiki-page:
wiki-name: "MyProject.wiki" # Required β wiki identifier (name or GUID)
wiki-project: "OtherProject" # Optional β defaults to current project
path-prefix: "/agent-output" # Optional β prepended to agent-supplied path
title-prefix: "[Agent] " # Optional β prepended to the last path segment
comment: "Updated by agent" # Optional β default commit commentSuggested Fixes
- Add
edit_wiki_page.rsto thesrc/tools/listing in the Architecture section of.github/copilot-instructions.md - Add a new
#### edit-wiki-pagesection under Safe Output Tools documenting agent parameters and front matter configuration options - Note that
wiki-nameis required for execution (tool fails without it)
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check Β· β·
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation