Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025

PR #118 added awf logs stats and awf logs summary commands but didn't include documentation. This PR adds comprehensive docs for both commands.

Changes

  • CLI Reference (docs-site/src/content/docs/reference/cli-reference.md): Added awf logs stats and awf logs summary subcommands with options, output formats, examples, and guidance on when to use each
  • Usage Guide (docs/usage.md): New "Log Analysis" section with command examples and sample output
  • Logging Quick Reference (docs/logging_quickref.md): Added commands as primary methods for getting statistics
  • GitHub Actions Guide (docs/github_actions.md): New "Generating Firewall Summaries" section showing CI integration

Example Usage

# Terminal stats (colorized output)
awf logs stats

# GitHub Actions step summary
awf logs summary >> $GITHUB_STEP_SUMMARY

# JSON for scripting
awf logs stats --format json

Screenshot

CLI Reference documentation showing awf logs stats and summary commands

Original prompt

Improve docs on #118

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


✨ 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: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation for better understanding docs: add documentation for awf logs stats and summary commands Dec 19, 2025
Copilot AI requested a review from Mossaka December 19, 2025 22:22
@Mossaka
Copy link
Collaborator

Mossaka commented Dec 19, 2025

@copilot try this again and visualzie the docs: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro build

@Mossaka Mossaka marked this pull request as ready for review December 19, 2025 23:11
@github-actions
Copy link

Test Coverage Report

Metric Coverage Covered/Total
Lines 71.29% 991/1390
Statements 71.39% 1016/1423
Functions 69.42% 109/157
Branches 66.33% 337/508
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`

Copy link
Contributor Author

Copilot AI commented Dec 19, 2025

@copilot try this again and visualzie the docs: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro build

Built the docs site with npm run build and verified it renders correctly. Screenshot shows the CLI Reference page with the new awf logs stats and awf logs summary sections.

CLI Reference documentation

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 preview --port 4321 (dns block)

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

@Mossaka Mossaka merged commit 5c95bbc into main Dec 19, 2025
14 checks passed
@Mossaka Mossaka deleted the copilot/improve-documentation-clarity branch December 19, 2025 23:33
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