Repository navigation
feat(md-exports): Link Markdown export in page body and head - #20916
Open
coolguyzone wants to merge 2 commits into
Open
coolguyzone wants to merge 2 commits into
coolguyzone wants to merge 2 commits into
Conversation
The only pointer to a page's .md export was inside the Copy page dropdown, which renders client-side on click, so agents fetching the HTML never saw it. Add a server-rendered notice under each page's title linking the .md export and llms.txt, plus a <link rel="alternate" type="text/markdown"> tag. The notice sits outside div#main, so it stays out of the generated Markdown exports and the Algolia index. Co-Authored-By: Claude Opus 5.5 <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Screen readers read the notice on every page, right before the content, and spelled out each full URL. Drop the protocol from the visible link text (the href keeps it) and trim the wording. Co-Authored-By: Claude Opus 5.5 <[email protected]>
coolguyzone
marked this pull request as ready for review
November 20, 2026 23:38
Contributor
|
Getting ready to monitor this change · Rollout details
|
This branch was successfully deployed
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.
DESCRIBE YOUR PR
Every page has a Markdown export at
<path>.md, but the only link to it was "View as Markdown" in the Copy page dropdown. That menu renders client-side on click, so it isn't in the server HTML at all, and agents fetching a page never see the URL.This adds two pointers that are in the server-rendered HTML:
docs.sentry.io/<path>.md. Index of all pages:docs.sentry.io/llms.txt." The URLs are written out as link text, so they survive tools that striphrefs. The protocol is dropped from the visible text (thehrefkeeps it) so screen readers don't spell out "https://" on every page. It's rendered once inDocPage, so no MDX changes are needed.<link rel="alternate" type="text/markdown" href="…/<path>.md">viaalternates.typesingenerateMetadata.The notice sits outside
div#main, so it's excluded from the generated.mdexports and the Algolia index. The Copy page dropdown is unchanged.To verify on the preview:
rel="alternate"link are there..mdexport and confirm the notice is not in it.r.jina.ai/<url>) and confirm the line survives near the top.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
🤖 Generated with Claude Code