docs(catalog): move hybrid headline, refresh RAG status, validate links#106
Merged
danielnaab merged 1 commit intomainfrom Apr 20, 2026
Merged
docs(catalog): move hybrid headline, refresh RAG status, validate links#106danielnaab merged 1 commit intomainfrom
danielnaab merged 1 commit intomainfrom
Conversation
…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.
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.
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