Skip to content

docs: update documentation for accuracy and consistency#492

Merged
Mossaka merged 4 commits intomainfrom
copilot/update-documentation-files-again
Feb 4, 2026
Merged

docs: update documentation for accuracy and consistency#492
Mossaka merged 4 commits intomainfrom
copilot/update-documentation-files-again

Conversation

Copy link
Contributor

Copilot AI commented Feb 3, 2026

Documentation audit to align docs with current CLI implementation and fix broken references.

Fixes

  • quickstart.md: Fixed hardcoded version 0.1.0 → dynamic reference; corrected wildcard support (was incorrectly marked as unsupported)
  • usage.md: Added missing CLI options (--enable-chroot, --container-workdir, --proxy-logs-dir, --allow-host-ports, --image-registry, --image-tag); added Chroot Mode section
  • chroot-mode.md: Kept original valid links to docs-site security-architecture.md and cli-reference.md
  • architecture.md: Fixed stale file paths (test-copilot-*.shtest-*.yml); updated terminology (copilot → agent container)
  • logging_quickref.md, troubleshooting.md: Fixed broken LOGGING.md references
  • README.md: Added missing doc links (GitHub Actions, Environment)

Example of corrected wildcard docs

# Before (incorrect - wildcards ARE supported)
# ✗ No wildcard syntax (use base domain instead)
--allow-domains '*.github.com'

# After (correct)
# ✓ Wildcard syntax is supported
--allow-domains '*.github.com'    # matches any subdomain of github.com

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

Original prompt

Technical Documentation Review: Audit and update all documentation files to ensure they accurately reflect the current state of the repository. This includes:

Review README.md for accuracy with current CLI options and features
Verify docs/*.md files match actual implementation
Ensure the new --enable-chroot feature is properly documented across all relevant docs
Check that code examples in documentation are working and up-to-date
Update any outdated installation instructions or version references
Add missing documentation for any undocumented features
Focus on consistency and accuracy between docs and actual codebase.

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] Audit and update technical documentation for accuracy docs: update documentation for accuracy and consistency Feb 3, 2026
Copilot AI requested a review from Mossaka February 3, 2026 20:04
Copy link
Collaborator

@Mossaka Mossaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: REQUEST_CHANGES

@copilot Please fix the following issue:

Critical Issue: Wrong Security Document Link

In docs/chroot-mode.md, you replaced:

  • ../docs-site/src/content/docs/reference/security-architecture.md (comprehensive security architecture doc)

with:

  • ./security.md (generic bug bounty/reporting policy)

These are fundamentally different documents. The security-architecture.md covers threat models, design principles, and what the firewall protects against. The security.md is a standard GitHub security reporting template.

Required Fix

Either:

  1. Keep the original link to security-architecture.md
  2. Create a proper security model doc in docs/ that summarizes the key security architecture points
  3. Remove the security link entirely rather than point to the wrong document

Note

The other changes in this PR (wildcard support fix, broken LOGGING.md link fixes, CLI option additions) are correct and valuable. Only the security link replacement is problematic.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 4, 2026

Review: REQUEST_CHANGES

@copilot Please fix the following issue:...

Fixed in 351c778. I incorrectly assumed the docs-site paths were broken, but both security-architecture.md and cli-reference.md exist and are valid. I've restored the original links to point to the correct documents.

Copilot AI requested a review from Mossaka February 4, 2026 17:09
@Mossaka Mossaka marked this pull request as ready for review February 4, 2026 17:37
Copilot AI review requested due to automatic review settings February 4, 2026 17:37
@github-actions
Copy link

github-actions bot commented Feb 4, 2026

📰 DEVELOPING STORY: Smoke Copilot reports failed. Our correspondents are investigating the incident...

@github-actions
Copy link

github-actions bot commented Feb 4, 2026

💫 TO BE CONTINUED... Smoke Claude failed! Our hero faces unexpected challenges...

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR performs a comprehensive documentation audit to align documentation with the current CLI implementation. The changes fix inaccuracies, update stale references, and add missing documentation for recently added features.

Changes:

  • Fixed wildcard support documentation (was incorrectly marked as unsupported)
  • Added documentation for 6 missing CLI options (--enable-chroot, --container-workdir, --proxy-logs-dir, --allow-host-ports, --image-registry, --image-tag)
  • Updated stale file paths in architecture.md (test-copilot-.sh scripts → test-.yml workflows)
  • Updated terminology consistently (copilot → agent container)
  • Fixed broken LOGGING.md references throughout documentation
  • Updated version reference from hardcoded 0.1.0 to dynamic example (0.13.1)

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/usage.md Added 6 missing CLI options, new Chroot Mode section, updated command syntax
docs/troubleshooting.md Fixed broken LOGGING.md reference to point to logging_quickref.md
docs/quickstart.md Fixed hardcoded version reference and corrected wildcard support documentation
docs/logging_quickref.md Updated terminology (copilot → agent container) and fixed references
docs/architecture.md Fixed stale file paths and updated terminology throughout
README.md Added links to GitHub Actions and Environment documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

--enable-host-access Enable access to host services via host.docker.internal
(see "Host Access" section for security implications)
--allow-host-ports <ports> Ports to allow when using --enable-host-access
Example: --allow-host-ports 3000,8080 or 3000-3010
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example for --allow-host-ports is incomplete compared to the actual CLI help text. The CLI help shows three variations: single port (3000), multiple ports (3000,8080), and complex ranges (3000-3010,8000-8090). The documentation should include all three examples for completeness and clarity.

Suggested change
Example: --allow-host-ports 3000,8080 or 3000-3010
Examples: --allow-host-ports 3000, 3000,8080, or 3000-3010,8000-8090

Copilot uses AI. Check for mistakes.
Copy link
Collaborator

@Mossaka Mossaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The security link issue was already fixed in commit 351c778. The documentation changes are valuable - approving.

@Mossaka Mossaka merged commit d316ee7 into main Feb 4, 2026
25 of 28 checks passed
@Mossaka Mossaka deleted the copilot/update-documentation-files-again branch February 4, 2026 17:42
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