Skip to content

fix(docs): repair a broken catalog table and four stale homepage counts - #34

Merged
burinc merged 1 commit into
mainfrom
fix/home-counts-and-catalog-table
Sep 20, 2026
Merged

burinc merged 1 commit into
mainfrom
fix/home-counts-and-catalog-table

Conversation

@burinc

@burinc burinc commented Sep 20, 2026

Copy link
Copy Markdown
Member

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 else

The basic-lighting row sat ABOVE its table header, so the whole shaders
table collapsed on the site.

My insertion script sorted rows by the text between the first pair of
backticks. The header line | preview | bb name | shows | also contains
backticks, yielding "bb". Since basic-lighting sorts before bb, the
header 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 -20 and it cut the output at exactly the line that would have shown
them. 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.html at all.

  • The catalog gate now requires each group table to start with its header, and
    each ## group (N) heading to match the rows beneath it.
  • The homepage gate now 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. That is worth stating because a gate
that cannot fail is worse than no gate: it reads as coverage.

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.
@burinc
burinc merged commit 4a2c436 into main Sep 20, 2026
3 checks passed
@burinc
burinc deleted the fix/home-counts-and-catalog-table branch September 20, 2026 05:07
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