docs: update documentation for accuracy and consistency#492
Conversation
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Mossaka
left a comment
There was a problem hiding this comment.
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:
- Keep the original link to
security-architecture.md - Create a proper security model doc in
docs/that summarizes the key security architecture points - 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>
|
📰 DEVELOPING STORY: Smoke Copilot reports failed. Our correspondents are investigating the incident... |
|
💫 TO BE CONTINUED... Smoke Claude failed! Our hero faces unexpected challenges... |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
| Example: --allow-host-ports 3000,8080 or 3000-3010 | |
| Examples: --allow-host-ports 3000, 3000,8080, or 3000-3010,8000-8090 |
Documentation audit to align docs with current CLI implementation and fix broken references.
Fixes
0.1.0→ dynamic reference; corrected wildcard support (was incorrectly marked as unsupported)--enable-chroot,--container-workdir,--proxy-logs-dir,--allow-host-ports,--image-registry,--image-tag); added Chroot Mode sectiondocs-sitesecurity-architecture.md and cli-reference.mdtest-copilot-*.sh→test-*.yml); updated terminology (copilot → agent container)LOGGING.mdreferencesExample of corrected wildcard docs
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.