docs: wrap agent-firewall inject-target placeholders in backticks#209
Open
nickvigilante wants to merge 1 commit into
Open
docs: wrap agent-firewall inject-target placeholders in backticks#209nickvigilante wants to merge 1 commit into
nickvigilante wants to merge 1 commit into
Conversation
The --session-id-inject-target help text is surfaced in Coder's generated CLI reference (docs/reference/cli/agent-firewall.md). Its `<host>` and `<glob>` placeholders were parsed as unknown HTML tags by the docs site and dropped, so the format and example rendered as broken text. Wrap the format template and example in backticks so they render as inline code, matching coder/coder's documented "Placeholders in angle brackets" convention. This also converts the raw string literal to a double-quoted string, consistent with the neighboring option descriptions. No behavior change; terminal --help output only gains the backticks. > This PR was created with AI assistance (Coder Agents).
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.
What
The
--session-id-inject-targetflag help is surfaced verbatim in Coder'sgenerated CLI reference,
docs/reference/cli/agent-firewall.md.Its
<host>and<glob>placeholders were parsed as unknown HTML tags by thedocs site and dropped, so the format and example rendered as broken text
(readers saw
Format: "domain= [path=]").Change
Wrap the format template and example in backticks so they render as inline code
(angle brackets inside a code span are inert). This matches coder/coder's
documented
Placeholders in angle brackets
convention. The raw string literal is converted to a double-quoted string,
consistent with the neighboring option descriptions.
No behavior change; the terminal
--helpoutput only gains the backticks.Before:
After:
Downstream
Once this is released, coder/coder bumps
github.com/coder/boundaryandregenerates
agent-firewall.mdto pick it up.Tracking (Coder internal): DOCS-583