docs: audit and update documentation for CLI accuracy #455
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update quickstart.md: change version 0.1.0 to current version - Update usage.md: add missing CLI options (container-workdir, image-registry, image-tag, proxy-logs-dir, allow-host-ports, enable-chroot) - Remove incorrect wildcard limitation from quickstart.md - Add wildcard pattern examples to quickstart.md Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Add missing options to docs-site CLI reference: - --agent-image - --enable-host-access - --allow-host-ports - --proxy-logs-dir Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Audit and update technical documentation files
docs: audit and update documentation for CLI accuracy
Jan 30, 2026
Collaborator
|
@copilot please merge origin/main |
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation diverged from implementation. Ten CLI options were undocumented, version references were hardcoded, and wildcard support was incorrectly marked as unsupported.
Changes
CLI Option Documentation
docs/usage.md:--container-workdir,--image-registry,--image-tag,--proxy-logs-dir,--allow-host-ports,--enable-chrootdocs-site/src/content/docs/reference/cli-reference.md:--agent-image,--enable-host-access,--allow-host-ports,--proxy-logs-dirVersion Reference
0.1.0in quickstart to dynamic example to prevent stalenessWildcard Support
*.github.com,api-*.example.com)Verified Accurate
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.