docs: condense get started fast section #504
Draft
+6
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Refactor 'Get Started Fast' section of README
docs: condense get started fast section
Feb 4, 2026
Mossaka
requested changes
Feb 4, 2026
Collaborator
Mossaka
left a comment
Mossaka
left a comment
There was a problem hiding this comment.
Review: REQUEST_CHANGES
@copilot Please fix the following issues:
Problem
The "Get started fast" section now only shows installation but removes the usage example entirely. A "Get started fast" section that only shows how to install - but not how to USE - the tool defeats its purpose.
What was removed that should be kept:
- The example command showing how to actually run
awfafter installation - The explanation about the
--separator (critical syntax)
Required Fix
Keep at least one usage example. A minimal but complete version:
## Get started fast
```bash
curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash
sudo awf --allow-domains github.com -- curl https://api.github.com
This keeps it terse (two lines) while showing both installation AND basic usage.
The prerequisite note about Docker can optionally be removed, but the usage example is essential.
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Contributor
Author
Added a minimal usage example and a one-sentence |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reduce README bloat by keeping “Get started fast” terse while still showing installation and a minimal usage example.
awfusage) and add a one-sentence note explaining the--separator.curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash sudo awf --allow-domains github.com -- curl https://api.github.comThe
--separator divides firewall options from the command to run.Original prompt
💡 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.