Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
| Area |
Issue |
File(s) |
| Architecture Section |
tools/noop.rs is absent from the directory tree listing |
.github/copilot-instructions.md |
| CLI Commands |
--verbose / --debug global flags exist in the binary but are not documented |
.github/copilot-instructions.md, agentic-pipelines/src/main.rs |
Details
1. tools/noop.rs missing from architecture tree
The architecture tree under the Architecture section lists the tools/ directory as:
βββ tools/ # MCP tool implementations
βββ mod.rs
βββ create_pr.rs
βββ create_work_item.rs
βββ memory.rs
βββ missing_data.rs
βββ missing_tool.rs
βββ result.rs
However, the actual agentic-pipelines/src/tools/ directory also contains noop.rs, which is a fully implemented tool (exported via mod.rs as pub use noop::*;). The noop tool itself is correctly documented in the Safe Output Tools section β only the file is missing from the architecture tree.
2. Global --verbose and --debug CLI flags are undocumented
agentic-pipelines/src/main.rs defines two global flags on the Args struct:
/// Enable verbose logging (info level)
#[arg(short, long, global = true)]
verbose: bool,
/// Enable debug logging (debug level, implies verbose)
#[arg(short, long, global = true)]
debug: bool,
These flags (-v/--verbose and -d/--debug) apply to every subcommand but are not mentioned anywhere in the CLI Commands section of the documentation.
Suggested Fixes
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check Β· β·
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
tools/noop.rsis absent from the directory tree listing.github/copilot-instructions.md--verbose/--debugglobal flags exist in the binary but are not documented.github/copilot-instructions.md,agentic-pipelines/src/main.rsDetails
1.
tools/noop.rsmissing from architecture treeThe architecture tree under the Architecture section lists the
tools/directory as:However, the actual
agentic-pipelines/src/tools/directory also containsnoop.rs, which is a fully implemented tool (exported viamod.rsaspub use noop::*;). Thenooptool itself is correctly documented in the Safe Output Tools section β only the file is missing from the architecture tree.2. Global
--verboseand--debugCLI flags are undocumentedagentic-pipelines/src/main.rsdefines two global flags on theArgsstruct:These flags (
-v/--verboseand-d/--debug) apply to every subcommand but are not mentioned anywhere in the CLI Commands section of the documentation.Suggested Fixes
noop.rsto thetools/directory listing in the architecture tree--verbose/--debug) in the CLI Commands section, e.g.:This issue was created by the automated documentation freshness check.