Skip to content

docs: add protocol-specific domain filtering documentation#149

Merged
Mossaka merged 3 commits intomainfrom
copilot/improve-docs-for-firewall
Dec 19, 2025
Merged

docs: add protocol-specific domain filtering documentation#149
Mossaka merged 3 commits intomainfrom
copilot/improve-docs-for-firewall

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025

Documents the protocol-specific domain filtering feature from PR #115, which allows restricting domains to HTTP-only or HTTPS-only traffic.

Changes Made

  • docs-site/src/content/docs/index.md: Added "Protocol-Specific Filtering" section with usage examples showing how to restrict domains to HTTPS-only, HTTP-only, or both protocols
  • docs-site/src/content/docs/reference/cli-reference.md: Enhanced --allow-domains option documentation with protocol-specific filtering examples and wildcard support

Examples Added

# HTTPS only (secure endpoints)
--allow-domains 'https://secure.example.com'

# HTTP only (legacy APIs)
--allow-domains 'http://legacy-api.example.com'

# Both protocols (default, backward compatible)
--allow-domains 'example.com'

# Works with wildcards
--allow-domains 'https://*.secure.example.com'

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

Original prompt

improve docs on #115 (do not modify README)

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.

@Mossaka
Copy link
Collaborator

Mossaka commented Dec 19, 2025

@copilot improve docs on #115 (do not modify README)

Copilot AI and others added 2 commits December 19, 2025 22:17
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Dec 19, 2025

@copilot improve docs on #115 (do not modify README)

Added documentation for the protocol-specific domain filtering feature from PR #115. Changes in commit a430136:

  • Added "Protocol-Specific Filtering" section to docs-site homepage with usage examples
  • Added protocol filtering documentation to CLI reference under --allow-domains option

The docs-site build was verified to work correctly.

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)

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

Copilot AI changed the title [WIP] Improve documentation for firewall functionality docs: add protocol-specific domain filtering documentation Dec 19, 2025
@Mossaka
Copy link
Collaborator

Mossaka commented Dec 19, 2025

@copilot try this again: /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
Contributor

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: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro build

The docs-site build completed successfully:

[build] 4 page(s) built in 16.78s
[build] Complete!

All pages were built including the updated index.md and cli-reference.md with protocol-specific domain filtering 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 node_modules/.bin/astro build (dns block)

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

@Mossaka Mossaka merged commit 45da48d into main Dec 19, 2025
13 checks passed
@Mossaka Mossaka deleted the copilot/improve-docs-for-firewall 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