Skip to content

docs: wrap agent-firewall inject-target placeholders in backticks#209

Merged
nickvigilante merged 1 commit into
mainfrom
vigilante/docs-583-backtick-agent-firewall-placeholders
Jul 19, 2026
Merged

docs: wrap agent-firewall inject-target placeholders in backticks#209
nickvigilante merged 1 commit into
mainfrom
vigilante/docs-583-backtick-agent-firewall-placeholders

Conversation

@nickvigilante

Copy link
Copy Markdown
Contributor

What

The --session-id-inject-target flag help is surfaced verbatim 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
(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 --help output only gains the backticks.

Before:

Format: "domain=<host> [path=<glob>]". Example: --session-id-inject-target "domain=prod.coder.com path=/api/v2/aibridge/*".

After:

Format: `domain=<host> [path=<glob>]`. Example: `--session-id-inject-target "domain=prod.coder.com path=/api/v2/aibridge/*"`.

Downstream

Once this is released, coder/coder bumps github.com/coder/boundary and
regenerates agent-firewall.md to pick it up.

Tracking (Coder internal): DOCS-583

This PR was created with AI assistance (Coder Agents).

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).
@linear-code

linear-code Bot commented Jul 16, 2026

Copy link
Copy Markdown

DOCS-583

@nickvigilante
nickvigilante marked this pull request as ready for review July 16, 2026 19:32
@nickvigilante
nickvigilante merged commit 32f3ec9 into main Jul 19, 2026
5 checks passed
@nickvigilante
nickvigilante deleted the vigilante/docs-583-backtick-agent-firewall-placeholders branch July 19, 2026 15:29
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