Skip to content

πŸ“ Documentation drift detected β€” missing noop.rs in architecture tree and undocumented global CLI flagsΒ #4

@github-actions

Description

@github-actions

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

  • Add noop.rs to the tools/ directory listing in the architecture tree
  • Add a note about global flags (--verbose/--debug) in the CLI Commands section, e.g.:

    Global flags (apply to all subcommands): --verbose, -v (info logging), --debug, -d (debug logging, implies verbose)


This issue was created by the automated documentation freshness check.

Generated by Documentation Freshness Check Β· β—·

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions