fix(docs): strip br: markers — this tree is rendered, so they show up on the page - #52
Merged
Merged
Conversation
… on the page #50 added 12 `<!-- br:x -->N<!-- /br:x -->` markers across 5 docs files. Markers are inert only where something renders markdown as HTML and drops comments. This tree is the exception: blockrun's docs renderer ESCAPES the comment onto the page, so a reader sees the literal `<!-- br:models.free -->`. blockrun asserts this — brand-numbers.docs.test.ts's "carries no br: markers — this renderer escapes them into view". It went unnoticed because blockrun consumes this repo as a SUBMODULE PINNED to an older commit, so #50 could sit on main perfectly green while being unshippable. It only turned red when a pointer bump pulled it in (blockrun#397, the GLM-5.3 launch). Stripping the wrapper leaves the value, which is exactly what the guard wants: docs/ keeps plain numbers and the TEST is what catches staleness. Same trade already made for public/*.md, llms.txt, package.json descriptions and shields badges, none of which markers can reach either.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#50 added 12
<!-- br:x -->N<!-- /br:x -->markers across 5 files. This tree cannot carry them.Markers are inert only where something renders the markdown as HTML and drops comments. blockrun's docs renderer escapes the comment onto the page, so a reader sees the literal
<!-- br:models.free -->in the text.blockrun asserts exactly this, in
brand-numbers.docs.test.ts: "carries no br: markers — this renderer escapes them into view".Why #50 looked fine
blockrun consumes this repo as a submodule pinned to an older commit. #50 could sit on
mainperfectly green while being unshippable, because nothing referenced it yet. It only turned red when a pointer bump pulled it in — blockrun#397, the GLM-5.3 launch, which is how this surfaced at all.That is worth knowing beyond this fix: green CI here does not mean shippable, because the consumer pins. Anything that depends on how blockrun renders these files is only validated at pointer-bump time.
The fix
Strip the wrapper, keep the value.
docs/goes back to plain numbers and the test is what catches staleness — the same trade already made forpublic/*.md,llms.txt,package.jsondescriptions and shields badges, none of which markers can reach either.12 markers, 5 files, values unchanged. blockrun's docs guard passes against this commit.