diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 11:28:46 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-07 11:28:46 +0300 |
| commit | beb5f2c4f0c0565ca76c68f302fcd0217004bedf (patch) | |
| tree | 05ebbac727010fda0c6fb4911d07776ca9f9f720 /docs/_static | |
| parent | a42e5f6828a5b2f640b5e8b64510aa00d0e0e798 (diff) | |
| download | vyos-documentation-beb5f2c4f0c0565ca76c68f302fcd0217004bedf.tar.gz vyos-documentation-beb5f2c4f0c0565ca76c68f302fcd0217004bedf.zip | |
docs(claude-md): fix Markdown rendering + clarify rst- prefix wording
Three rendering/clarity fixes flagged by Copilot review across the
post-flip CLAUDE.md trio (#1902/#1906/#1907):
1. **Triple-backtick examples in single-backtick code spans broke
Markdown rendering.** The MyST fence example
```{cfgcmd} set system ...``` was wrapped in a single-backtick
span, where the inner triple backticks confuse the parser. Switch
to a four-backtick code span so the literal fence renders cleanly.
Same fix applied to the "Configuration page structure" bullet.
2. **RST inline-literal example used confusing nested backticks.** The
line "Inline code: \`\`\`\`command\`\`\`\`" parsed but
was hard to read. Replace with a plain explanation:
"Inline code: use double backticks (\`\`command\`\`)".
3. **Clarify that the `rst-` override prefix attaches to the basename,
not the path stem.** The previous wording `docs/rst-<page>.rst`
could be misread as a top-level prefix. The actual behavior in
`scripts/swap_sources.py` is: for a page at
`docs/automation/cloud-init.md`, the override file lives at
`docs/automation/rst-cloud-init.rst` (basename-prefixed sibling).
Spell that out with a concrete example.
Same fixes applied symmetrically across [#1902](https://github.com/vyos/vyos-documentation/pull/1902) (current),
[#1906](https://github.com/vyos/vyos-documentation/pull/1906) (circinus), and [#1907](https://github.com/vyos/vyos-documentation/pull/1907) (sagitta) — all three worktrees
back to byte-identical (md5 `d1ceaddc...`).
\xf0\x9f\xa4\x96 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/_static')
0 files changed, 0 insertions, 0 deletions
