Skip to content

fix: three install commands render outside their code blocks - #29

Merged
tactino merged 2 commits into
mainfrom
docs/readme-demo
Sep 18, 2026
Merged

tactino merged 2 commits into
mainfrom
docs/readme-demo

Conversation

@tactino

@tactino tactino commented Sep 18, 2026

Copy link
Copy Markdown
Member

Two fixes that missed #28 - they were pushed to the branch after it had already been merged.

The install commands render outside their code blocks

Three of them: curl -LsSf ..., uv sync, uv run python -m plugrl_server.cli --help. In the developer list the opening fence sits at four spaces and the command under it at two. Less indentation than the list item's content ends the item, so GitHub closes the list, renders the command as an ordinary paragraph and prints the closing fence as literal text. The same two-space indent pulls the explanatory sentences out of their items too.

Checked against the rendered HTML rather than the source:

$ gh api -H "Accept: application/vnd.github.html" repos/PlugRL/plugrl-server/readme | grep -c '```'
3

Three stray fences on main, one per broken block, and none anywhere else. After the fix the same query returns 0 and each command sits inside a <pre>. plugrl-env-client, plugrl-protocol and the documentation site were checked the same way: 0.

The caption counts episodes the clip no longer shows

It says three. The gif on the site is being recut to one complete episode - plugrl.github.io#10 - because the old one stopped eight frames before the grasp finished. The caption now says "one episode of the three that ran, all three successful".

tactino added 2 commits September 18, 2026 16:56
The gif was recut to one complete episode after the old one turned out to stop before the grasp finished, which left the caption claiming three.
In the developer list the opening fence sat at four spaces while the command under it sat at two. Less indentation than the list item's content ends the item, so GitHub closed the list, rendered the command as a paragraph and printed the closing fence as literal text. The same two-space indent pulled the explanatory lines out of their items too.

Everything belonging to a list item is now at four spaces. Verified against the rendered HTML: the API returned exactly three stray fences, one per broken block.
@tactino
tactino merged commit 026d70c into main Sep 18, 2026
3 checks passed
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.

1 participant