Skip to content

docs(catalog): move hybrid headline, refresh RAG status, validate links#106

Merged
danielnaab merged 1 commit intomainfrom
docs/catalog-cleanup
Apr 20, 2026
Merged

docs(catalog): move hybrid headline, refresh RAG status, validate links#106
danielnaab merged 1 commit intomainfrom
docs/catalog-cleanup

Conversation

@danielnaab
Copy link
Copy Markdown
Member

Three cleanups on the catalog surface.

1. "Headline finding" moved off the catalog landing

The hybrid-v1 SummaryBox on `/catalog` claimed it as the catalog's headline finding, but it's only a finding about the PDF extraction suite — and the extraction suite's `_suite.md` already has the same content under "Summary of findings". Presenting it at the root misled visitors into thinking it covered every experiment. Removed from the landing page; the authoritative home remains `/catalog/experiments/pdf-field-extraction`.

2. Authoring-pipeline suite page refreshed

3. Internal-link validator

`scripts/validate-catalog-links.ts` scans every `/catalog/...` URL in TSX routes and markdown files plus every relative markdown link inside the catalog, verifies each resolves to an actual file, directory, or known code route, and fails non-zero when any don't. Wired into `bun run check`.

Caught one real broken link on first run: `catalog/decisions/design-system/component-scaffold.md` was using `../../notes/` when it should have been `../../../notes/`. Also revealed ~35 false positives the validator now skips (dynamic template literals like `${slug}`, custom `src:` protocol from the github-permalink renderer, external URLs).

185 catalog references checked across 94 markdown files and 8 TSX files — all resolve.

Testing

  • `bun run check` — 1332 tests pass, link validator passes.

…status, validate links

Three related cleanups on the catalog surface.

1) Move the hybrid-v1 "headline finding" off the catalog landing
   page. It's a claim about the PDF extraction suite, not about the
   catalog overall — presenting it at the root misleads visitors
   into thinking it covers every experiment. The extraction suite's
   _suite.md already hosts the same finding as its "Summary of
   findings" section, which is the right home.

2) Refresh the authoring-pipeline suite page to reflect current
   state: corpus expanded from 13 to 21 chunks, structure prompt
   de-leaked (#105), RAG ablation run. Rename index.md to _suite.md
   so /catalog/experiments/authoring-pipeline resolves as a suite
   (matches the convention used by the other suites) and update the
   landing card href.

3) Add scripts/validate-catalog-links.ts and wire it into
   \`bun run check\`. Finds all /catalog/... URLs in TSX routes and
   markdown files and all relative markdown links within the
   catalog; verifies each resolves to an actual file, directory, or
   known code route. Caught one real broken link
   (catalog/decisions/design-system/component-scaffold.md was using
   ../../notes/ when it should have been ../../../notes/) along
   with a pile of false positives that the validator now skips
   (dynamic template literals, custom src: protocol, external URLs).

185 references checked across 94 markdown files and 8 TSX files —
all resolve.
@danielnaab danielnaab merged commit f801294 into main Apr 20, 2026
4 checks passed
@danielnaab danielnaab deleted the docs/catalog-cleanup branch April 20, 2026 18:52
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