docs: add the journey components, page templates, lint scripts and the llms.txt generator - #2699
Merged
Merged
Conversation
…e llms.txt generator
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
palfrey
approved these changes
Aug 19, 2026
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.
What and why
Adds the machinery the docs rewrite is built on, with no page changes: five MDX components (Prerequisites, NextStep, VerifyBlock, SourceLink, MinVersion), the pinned source ref every
<SourceLink>resolves against, four page templates, five lint scripts (explicit anchors, internal links, config snippets against the generated reference, call-to-action boundary, reading-path dead ends), a generator that writes/llms.txtand/llms-full.txtfrom the navigation so agents can read the corpus in one fetch, andAGENTS.mdat the repo root for agents working on the code. Landing it first lets the content PR be reviewed for content alone.How was this verified?
bun run buildon main's existing pages with the new components registered (57 pages). Pre-commit hooks (Vale, typos, whitespace, json) pass over the changed files. The lint scripts were exercised against the rewritten content in the follow-up PR; they are not wired into CI here because two of them fail on the old pages (stale config snippets, pricing links), so the workflow ships with the content.Risk
Low. New files plus a title-template change in
layout.tsx; dev/build now also rungen:llms, which writes two gitignored files underpublic/. Nothing user-visible changes except/llms.txtand/llms-full.txtappearing on the site.This change is