Skip to content

docs: streamline README quickstart section - #185

Merged
Mossaka merged 2 commits into
mainfrom
copilot/remove-readme-bloat
Jan 6, 2026
Merged

docs: streamline README quickstart section#185
Mossaka merged 2 commits into
mainfrom
copilot/remove-readme-bloat

Conversation

CopilotAI commented Jan 5, 2026

Copy link
Copy Markdown
Contributor

The “Get started fast” block in the README was overly long and duplicated details better covered in the Quick start doc.

  • Quickstart trim: Reduced the section to prerequisite, one-line install, and first command; kept Copilot one-liner.
  • De-duplication: Pointed readers to docs/quickstart.md for checksum, version pinning, and manual install details.
  • Clarity: Retained cosign verification reference; removed redundant install variants and verbose checks.

Example snippet now shown:

curl -sSL https://raw.githubusercontent.com/githubnext/gh-aw-firewall/main/install.sh | sudo bash
sudo awf --allow-domains github.com -- curl https://api.github.com
Original prompt

unbloat Get started fast in README

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


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
CopilotAI changed the title [WIP] Remove unnecessary content from README filedocs: streamline README quickstart sectionJan 5, 2026
CopilotAI requested a review from MossakaJanuary 5, 2026 23:27
@Mossaka
Mossaka marked this pull request as ready for review January 6, 2026 00:16
@Mossaka
Mossaka merged commit a667c2a into mainJan 6, 2026
11 checks passed
@Mossaka
Mossaka deleted the copilot/remove-readme-bloat branch January 6, 2026 00:16
@github-actions

Copy link
Copy Markdown
Contributor

Test Coverage Report

MetricCoverageCovered/Total
Lines81.02%1230/1518
Statements80.98%1261/1557
Functions78.16%136/174
Branches72.56%410/565
Coverage Thresholds

The project has the following coverage thresholds configured:

  • Lines: 38%
  • Statements: 38%
  • Functions: 35%
  • Branches: 30%

Coverage report generated by `npm run test:coverage`

Sign up for freeto 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

@Mossaka