Skip to content

docs: condense CLI reference page to true reference format#61

Merged
Mossaka merged 2 commits intomainfrom
copilot/condense-cli-reference-page
Nov 26, 2025
Merged

docs: condense CLI reference page to true reference format#61
Mossaka merged 2 commits intomainfrom
copilot/condense-cli-reference-page

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 26, 2025

CLI reference page was bloated with tutorials, usage patterns, and troubleshooting that belong elsewhere. Users couldn't quickly find specific options.

Changes

  • Added Options Summary table — scannable overview of all 15 CLI options with types, defaults, descriptions
  • Streamlined Options Details — brief descriptions with minimal examples, no tutorials
  • Added Exit Codes table — quick reference for return values
  • Added See Also links — points to quickstart, usage guide, troubleshooting for detailed content
  • Removed redundant sections — Basic Examples, Command Argument tips, Common Usage Patterns, Troubleshooting, Environment Variables details (all exist in other docs)

~720 lines → ~148 lines (80% reduction)

Screenshot

CLI Reference Page

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:

  • telemetry.astro.build
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro build (dns block)
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro dev (dns block)
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro preview (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Condense the CLI reference page to be like a real "reference" page, remove common usage patterns, troubleshooting and others, and people should easily find the reference of exact CLI comand or args.

Custom agent used: technical-doc-writer
AI technical documentation writer for awf library using Astro Starlight


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot AI changed the title [WIP] Update CLI reference page to focus on commands and arguments docs: condense CLI reference page to true reference format Nov 26, 2025
Copilot AI requested a review from Mossaka November 26, 2025 20:21
@Mossaka Mossaka marked this pull request as ready for review November 26, 2025 20:36
@Mossaka Mossaka merged commit 989d770 into main Nov 26, 2025
3 checks passed
@Mossaka Mossaka deleted the copilot/condense-cli-reference-page branch November 26, 2025 20:36
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.

2 participants