Skip to content

docs: document global CLI flags and confirm noop.rs in architecture tree#5

Merged
jamesadevine merged 2 commits intomainfrom
copilot/update-documentation-for-missing-files
Mar 6, 2026
Merged

docs: document global CLI flags and confirm noop.rs in architecture tree#5
jamesadevine merged 2 commits intomainfrom
copilot/update-documentation-for-missing-files

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 6, 2026

Weekly doc freshness audit flagged two drift issues in .github/copilot-instructions.md: noop.rs absent from the architecture tree listing, and the global --verbose/--debug flags missing from the CLI Commands section.

Changes

  • Architecture treenoop.rs was already present in the tree; no change required.
  • CLI Commands — Added a global flags note at the top of the section documenting -v/--verbose (info-level logging) and -d/--debug (debug-level logging, implies verbose), which are defined as global = true on the Args struct in main.rs and apply to every subcommand.
### CLI Commands

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

- `create` - Interactively create a new agent markdown file
  ...
Original prompt

This section details on the original issue you should resolve

<issue_title>📝 Documentation drift detected — missing noop.rs in architecture tree and undocumented global CLI flags</issue_title>
<issue_description>## 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 ·

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix documentation drift for architecture and CLI flags docs: document global CLI flags and confirm noop.rs in architecture tree Mar 6, 2026
@jamesadevine jamesadevine marked this pull request as ready for review March 6, 2026 14:51
@jamesadevine jamesadevine merged commit e0b1a9d into main Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📝 Documentation drift detected — missing noop.rs in architecture tree and undocumented global CLI flags

2 participants