fix(docs): repair a broken catalog table and four stale homepage counts - #34
Merged
Merged
Conversation
Two defects, both mine, both visible on the published site. The shaders table in the catalog had the basic-lighting row ABOVE its header, so the whole table rendered as a literal |---|---|--- and no rows at all. My insertion script sorted rows by the text between the first pair of backticks, and the header line "| preview | `bb` name | shows |" also has backticks, yielding "bb". Since basic-lighting sorts before bb, the header was chosen as the insert anchor. Only that one row was low enough in the alphabet to hit it. home.html still said 175 in four places: the call-to-action button, an architecture diagram label, a section heading and a shell comment. I corrected its headline and per-group counts in the previous commit and missed these because I piped the audit grep through head -20, which cut the output at exactly the line that would have shown them. Reading the whole file finds five 175s, not one. Both are now gated, because neither was catchable before. The catalog gate checks that each group table starts with its header and that the heading count matches the rows beneath. The homepage gate checks the example count wherever it appears and every per-group figure against the registry. Each of the five new checks was verified by planting the exact error it is meant to catch and confirming it fires.
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
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.
Two defects, both mine, both visible on the published site. Both now gated,
because neither was catchable before.
The shaders table rendered as
|---|---|---|and nothing elseThe
basic-lightingrow sat ABOVE its table header, so the whole shaderstable collapsed on the site.
My insertion script sorted rows by the text between the first pair of
backticks. The header line
| preview |bbname | shows |also containsbackticks, yielding
"bb". Sincebasic-lightingsorts beforebb, theheader was chosen as the insert anchor and the row went in front of it. Only
that one row was low enough in the alphabet to hit it, which is why it looked
fine everywhere else.
home.html still said 175 in four places
The call-to-action button, an architecture diagram label, a section heading
and a shell comment. I corrected the headline and per-group counts in the
previous PR and missed these, because I piped the audit grep through
head -20and it cut the output at exactly the line that would have shownthem. The file contains five
175s, not one.Gates
Neither defect was reachable by the existing checks: every row was present,
every image resolved, and nothing gated
home.htmlat all.each
## group (N)heading to match the rows beneath it.every per-group figure, against the registry.
Each of the five new checks was verified by planting the exact error it is
meant to catch and confirming it fires. That is worth stating because a gate
that cannot fail is worse than no gate: it reads as coverage.