Skip to content

RST conversion leftovers in generated code snippets (validator-disaster-recovery) #653

@8bitpal

Description

@8bitpal

Problem

The Recover the Coin balance of an external party section (and others on the same page) render raw RST directives that should have been stripped or converted, e.g. .. warning::, .. code::, .. code-block:: bash.

Root cause

These appear inside auto-generated code-block snippets, not in the page MDX itself. The page is clean; the leftovers come from the snippet-extraction step. The extractor pulls a line range out of the upstream Splice RST and, in these cases, the range spans past the actual code into surrounding RST directives, anchors, and even a section heading.

Confirmed in these generated snippets under docs-main/snippets/external/splice/main/:

Snippet Leftover content
splice-rst-code-docs-src-validator-operator-validator-disaster-recovery-none-309.mdx Contains .. code::, .. warning:: The target validator…, the RST anchor .. _validator_recover_external_party:, and the RST section heading Recover the Coin balance of an external party with its ++++ underline — all inside a fenced code block.
splice-rst-code-docs-src-validator-operator-validator-disaster-recovery-bash-137.mdx The fenced block opens with ```bash and then literally includes the RST directive line .. code-block:: bash before the actual kubectl command.
splice-rst-code-docs-src-validator-operator-validator-disaster-recovery-none-351.mdx One leftover RST directive.

Scope

This is a snippet-generation bug, not a one-page fix. The line-range extraction is grabbing RST directive/prose/heading lines around the intended code. Other pages that import similarly-generated splice-rst-code-* snippets likely have the same problem. A sweep across docs-main/snippets/external/splice/main/ for ^\s*\.\. and RST heading underlines (^[+=~^"]+$) inside code fences would quantify it.

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions