[test] tag one BrightScript fence to verify ReadMe rendering#51
Merged
jduval23 merged 1 commit intoMay 18, 2026
Merged
Conversation
Tags the AppendString() example block in ifstringops.md with ```brightscript to test whether ReadMe's syntax highlighter recognizes the language identifier and applies highlighting. The other 26 code blocks on the same page are intentionally left untagged, providing an A/B comparison on a single rendered page. If staging renders the tagged block with BrightScript highlighting, this validates the proposed repo-wide BrightScript fence sweep (~1,300 unlabeled fences across DEVELOPER + REFERENCES).
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
2 participants
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.
Purpose
This is a draft test PR, not intended to merge. It tags exactly one BrightScript code block with the ```brightscript info string in `docs/REFERENCES/brightscript/interfaces/ifstringops.md` (the AppendString() example, L48). The other 26 code blocks on the same page are intentionally left bare.
What I'm checking
Whether ReadMe's syntax highlighter recognizes the `brightscript` language identifier and renders the tagged block with highlighting (and/or with a "BrightScript" label in the code-block UI). The same page renders both the tagged block and 26 untagged blocks, providing an A/B comparison on a single rendered page.
Why it matters
There are ~1,300 unlabeled ``` code fences across `docs/DEVELOPER/` (588) and `docs/REFERENCES/` (717) that contain BrightScript samples. None of them carry a language identifier, so they all render as plain text. A repo-wide sweep to add ```brightscript would be the highest-leverage single PR for documentation rendering quality.
This test confirms the platform actually does something useful with the tag before scoping that sweep.
What to look at
Outcome
If staging shows visible BrightScript highlighting on the tagged block (or even just a "BrightScript" tab label) while the other 26 stay plain, the sweep is worth doing. If both render identically, the sweep is still worth doing for non-render reasons (lint enforcement, GitHub diff rendering, future platform migration), but the immediate user-facing benefit is smaller.
I'll close this PR once we have a result either way.