Skip to content

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: Fixed broken links to non-existent docs-site paths
  • 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
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
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