docs(readme): split agent-gate run flags into primary + advanced sections#34
Closed
WZ wants to merge 1 commit into
Closed
docs(readme): split agent-gate run flags into primary + advanced sections#34WZ wants to merge 1 commit into
WZ wants to merge 1 commit into
Conversation
Mirrors the layout that v0.3.4's `agent-gate run --help` actually prints. The everyday flags (--mode, --enforce-allowlist, --config) stay together; --upstream-ca, --upstream-insecure-skip-verify, and --hijack-host move into a clearly labeled "advanced flags" block at the bottom so first-time readers see the common surface first. Drive-by: dropped the "advanced — most users don't need this" preamble from --hijack-host's description since the section heading now does that work, matching what we already shipped in the binary's help text. Added a one-liner pointing readers at `agent-gate run --help` so the README and the binary stay in sync as the source of truth.
Owner
Author
|
Superseded by a larger README/RUNBOOK split — closing in favor of that PR. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The README's `### Flags` block listed every `agent-gate run` flag in one column. After v0.3.4 the binary's own `--help` splits them into a primary block (`--mode`, `--enforce-allowlist`, `--config`) and a trailing `Advanced Flags:` block (`--upstream-ca`, `--upstream-insecure-skip-verify`, `--hijack-host`). This PR mirrors that split in the README so the docs match what the binary actually prints.
Drive-by: dropped the "advanced — most users don't need this" preamble from `--hijack-host`'s description since the new section heading already says that. Same wording change shipped in the binary in v0.3.4.
Added a one-liner at the end pointing readers at `agent-gate run --help` so future flag changes only need a `--help` glance to verify the docs are in sync.
Pure docs. No code, no behavior change.
Test plan