diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 11:44:43 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 11:44:43 +0300 |
| commit | 5e1d1ebc6c13bbf32327aa672d7bf51bb2a28556 (patch) | |
| tree | 75829684550efe2fd24dfb5f9e88c2e6dd6cc539 | |
| parent | 0950184655410bf72fb38bcc93955080e3d62ee7 (diff) | |
| download | vyos-documentation-5e1d1ebc6c13bbf32327aa672d7bf51bb2a28556.tar.gz vyos-documentation-5e1d1ebc6c13bbf32327aa672d7bf51bb2a28556.zip | |
docs(claude-md): drop literal ``command`` example, link RST quickref instead
The previous wording `Inline code: use double backticks (\`\`command\`\`)`
included literal backslashes intended to escape the inner backticks.
Markdown doesn't interpret backslashes inside code spans, so the
backslashes rendered verbatim — the rendered output read as
\`\`command\`\` instead of the intended ``command``.
Replace with a prose-only line that links the RST docutils quickref
(Inline markup section). No literal RST snippet to escape; rendering
is straightforward.
Same fix applied symmetrically across [#1902](https://github.com/vyos/vyos-documentation/pull/1902)/[#1906](https://github.com/vyos/vyos-documentation/pull/1906)/[#1907](https://github.com/vyos/vyos-documentation/pull/1907) — the
trio is byte-identical (md5 `bdea8e5c...`).
\xf0\x9f\xa4\x96 Generated by [robots](https://vyos.io)
| -rw-r--r-- | CLAUDE.md | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -137,7 +137,7 @@ The first heading in every RST file uses `#` overline+underline. Field lists (e. - American English. - Indent with 2 spaces. - Blank lines around headings. -- Inline code: use double backticks (`\`\`command\`\``). +- Inline code: use double backticks per RST convention (the [Inline markup](https://docutils.sourceforge.io/docs/user/rst/quickref.html#inline-markup) section of the docutils quick reference). ### IP addresses (linter-enforced) |