-
Notifications
You must be signed in to change notification settings - Fork 28
Remove bloat from CLI commands documentation #4620
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Remove duplicate Quick Start section - Consolidate verbose "What it does" bullet lists into concise prose - Convert redundant options tables to inline descriptions - Simplify repetitive command patterns - Remove redundant Examples section - Condense verbose Strict Mode explanation Result: Reduced from 522 to 356 lines (32% reduction) All technical information preserved, documentation builds successfully Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR streamlines the CLI commands documentation by consolidating verbose content into concise descriptions, reducing the file from 522 to 356 lines (32% reduction). The changes improve readability while preserving all technical information and command specifications.
Key changes:
- Removed duplicate "Quick Start" section already covered in the "Most Common Commands" table
- Converted verbose bullet lists and tables into inline prose throughout command descriptions
- Consolidated Strict Mode security enforcement details into a single paragraph
- Updated labs.mdx with 5 new test workflow entries
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/src/content/docs/setup/cli.md | Condensed command documentation by removing redundant content, converting tables to inline descriptions, and consolidating verbose explanations while maintaining all technical details |
| docs/src/content/docs/labs.mdx | Added 5 new test workflow entries (daily-malicious-code-scan, test-serena-custom-gomod, test-serena-go-config, test-serena-long, test-serena-short) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Creates GitHub Actions workflow for MCP server setup | ||
| - Configures `.vscode/mcp.json` for VS Code integration | ||
| - Enables gh-aw MCP tools in Copilot Agent | ||
| Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, and sets up custom agent configuration. The `--mcp` flag additionally creates GitHub Actions workflow for MCP server setup, configures `.vscode/mcp.json` for VS Code integration, and enables gh-aw MCP tools in Copilot Agent. |
Copilot
AI
Nov 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This long sentence (77 words) is difficult to parse. Consider breaking it into two sentences, one for the base command and one for the --mcp flag. For example: "Configures .gitattributes to mark .lock.yml files as generated, adds Copilot instructions for better AI assistance, and sets up custom agent configuration. The --mcp flag additionally creates a GitHub Actions workflow for MCP server setup, configures .vscode/mcp.json for VS Code integration, and enables gh-aw MCP tools in Copilot Agent."
| Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, and sets up custom agent configuration. The `--mcp` flag additionally creates GitHub Actions workflow for MCP server setup, configures `.vscode/mcp.json` for VS Code integration, and enables gh-aw MCP tools in Copilot Agent. | |
| Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, and sets up custom agent configuration. | |
| The `--mcp` flag additionally creates a GitHub Actions workflow for MCP server setup, configures `.vscode/mcp.json` for VS Code integration, and enables gh-aw MCP tools in Copilot Agent. |
| - Creates GitHub Actions workflow for MCP server setup | ||
| - Configures `.vscode/mcp.json` for VS Code integration | ||
| - Enables gh-aw MCP tools in Copilot Agent | ||
| Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, and sets up custom agent configuration. The `--mcp` flag additionally creates GitHub Actions workflow for MCP server setup, configures `.vscode/mcp.json` for VS Code integration, and enables gh-aw MCP tools in Copilot Agent. |
Copilot
AI
Nov 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing article 'a' before 'GitHub Actions workflow' - should be 'creates a GitHub Actions workflow'
| Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, and sets up custom agent configuration. The `--mcp` flag additionally creates GitHub Actions workflow for MCP server setup, configures `.vscode/mcp.json` for VS Code integration, and enables gh-aw MCP tools in Copilot Agent. | |
| Configures `.gitattributes` to mark `.lock.yml` files as generated, adds Copilot instructions for better AI assistance, and sets up custom agent configuration. The `--mcp` flag additionally creates a GitHub Actions workflow for MCP server setup, configures `.vscode/mcp.json` for VS Code integration, and enables gh-aw MCP tools in Copilot Agent. |
| Investigate and analyze specific workflow runs. Provides detailed analysis including overview, execution metrics, tool usage patterns, MCP server failures, firewall analysis, noop messages, and artifact information. Accepts run IDs or URLs from any repository and GitHub instance. JSON output includes parsed noop messages similar to missing-tool reports. Automatically detects GitHub Copilot agent runs and uses specialized log parsing to extract agent-specific metrics including turns, tool calls, errors, and token usage. | ||
|
|
Copilot
AI
Nov 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] This paragraph contains 4 long sentences totaling 91 words, making it difficult to read. Consider breaking this into multiple shorter sentences or a brief bulleted list for better scannability, especially since it describes multiple distinct features.
| Investigate and analyze specific workflow runs. Provides detailed analysis including overview, execution metrics, tool usage patterns, MCP server failures, firewall analysis, noop messages, and artifact information. Accepts run IDs or URLs from any repository and GitHub instance. JSON output includes parsed noop messages similar to missing-tool reports. Automatically detects GitHub Copilot agent runs and uses specialized log parsing to extract agent-specific metrics including turns, tool calls, errors, and token usage. | |
| Investigate and analyze specific workflow runs. | |
| - Provides detailed analysis, including: | |
| - Overview and execution metrics | |
| - Tool usage patterns | |
| - MCP server failures | |
| - Firewall analysis | |
| - Noop messages | |
| - Artifact information | |
| - Accepts run IDs or URLs from any repository and GitHub instance | |
| - JSON output includes parsed noop messages similar to missing-tool reports | |
| - Automatically detects GitHub Copilot agent runs and uses specialized log parsing to extract agent-specific metrics: | |
| - Turns | |
| - Tool calls | |
| - Errors | |
| - Token usage |
| Update workflows to their latest versions. Updates workflows based on `source` field format `owner/repo/path@ref`. Replaces local file with upstream version (default) or performs 3-way merge to preserve local changes. Semantic version tags update within the same major version. Falls back to git commands when GitHub API authentication fails. Works with public repositories without requiring GitHub authentication. | ||
|
|
Copilot
AI
Nov 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] This description contains 6 sentences in a single paragraph (68 words), making it dense and difficult to scan. Consider separating the core functionality from the authentication details, or restructuring into two shorter paragraphs.
| Update workflows to their latest versions. Updates workflows based on `source` field format `owner/repo/path@ref`. Replaces local file with upstream version (default) or performs 3-way merge to preserve local changes. Semantic version tags update within the same major version. Falls back to git commands when GitHub API authentication fails. Works with public repositories without requiring GitHub authentication. | |
| Update workflows to their latest versions. Updates workflows based on the `source` field format `owner/repo/path@ref`. By default, the command replaces the local file with the latest upstream version, or performs a 3-way merge to preserve local changes. Semantic version tags update within the same major version. | |
| If GitHub API authentication fails, the command falls back to git commands. It works with public repositories without requiring GitHub authentication. |
Reduced CLI reference documentation from 522 to 356 lines (32% reduction) by removing verbose explanations while preserving technical accuracy.
Changes
--dir(organize in subdirectories),--number(create numbered copies))Example
Before:
After:
Screenshot
All command syntax, options, flags, and links preserved. Documentation builds successfully.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/githubnext/gh-aw/actions/artifacts/4654886720/zip/usr/bin/curl curl -L -H Authorization: token -H Accept: application/vnd.github+json REDACTED -o aw.patch.zip(http block)telemetry.astro.build/opt/hostedtoolcache/node/24.11.1/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)/opt/hostedtoolcache/node/24.11.1/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro dev(dns block)/opt/hostedtoolcache/node/24.11.1/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro dev --host 0.0.0.0 --port 4321(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.