feat(llm): Serve markdown inline via content negotiation#16023
Merged
feat(llm): Serve markdown inline via content negotiation#16023
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Member
Author
|
sitemap isnt effective enough - 9000+ links gonna take a slightly diff approach |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
dcramer
force-pushed
the
feat/llm-inline-markdown-serving
branch
from
d57f0a8 to
951505e
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
dcramer
force-pushed
the
feat/llm-inline-markdown-serving
branch
2 times, most recently
from
b22dfed to
347bff8
Compare
Change LLM/AI client detection from redirect to rewrite, so markdown content is served at the same URL when clients send Accept: text/markdown. Previously clients were redirected to .md URLs. Generate hierarchical sitemaps for LLM discovery: - Root index.md includes Sentry overview and links to top-level sections - Each section index page lists its child pages - Platform pages list guides separately from other pages - Guide pages list their sub-pages The DOCS_ORIGIN is now environment-aware for develop.sentry.dev support. Co-Authored-By: Claude <noreply@anthropic.com>
dcramer
force-pushed
the
feat/llm-inline-markdown-serving
branch
from
74b099d to
58168ce
Compare
Replaces the regex-based script tag removal with proper AST-based removal using unist-util-remove. This fixes CodeQL security alerts for: - js/incomplete-multi-character-sanitization - js/bad-tag-filter The AST-based approach is more robust and handles all edge cases that the regex could miss. Co-Authored-By: Claude <noreply@anthropic.com>
Replace existsSync check followed by read/write with try/catch around readFile. This eliminates the time-of-check to time-of-use race condition that CodeQL flagged as js/file-system-race. Co-Authored-By: Claude <noreply@anthropic.com>
1. Fix cache key calculation to exclude scripts - restores original caching behavior while keeping AST-based script removal for the actual processing. 2. Fix Quick Links for developer docs - conditionally show different quick links based on NEXT_PUBLIC_DEVELOPER_DOCS environment variable. 3. Upload modified parent files to R2 - parent index files with appended child page listings are now uploaded to R2 CDN. Co-Authored-By: Claude <noreply@anthropic.com>
dcramer
force-pushed
the
feat/llm-inline-markdown-serving
branch
from
006b0c6 to
cda5c4d
Compare
codyde
approved these changes
Jan 16, 2026
Add guidesIdx > 0 check to prevent invalid parent path calculation when guides directory appears at path position 0. Co-Authored-By: Claude <noreply@anthropic.com>
BYK
reviewed
Jan 20, 2026
BYK
reviewed
Jan 20, 2026
Comment on lines
+84
to
+85
| # Force markdown via query param | ||
| curl "https://docs.sentry.io/platforms/python/?format=md" |
Member
There was a problem hiding this comment.
We should also add curl "https://docs.sentry.io/platforms/python.md, right?
Member
Author
There was a problem hiding this comment.
is this file dead at this point? im gonna go spend some tim eon this repo to review state of it
Contributor
There was a problem hiding this comment.
I think i added the query param ages back, and then setup the automatic switch over to .md. It all still works now, but with the auto-negotiation, I dont think its going to be used much.
I think we use it on the copy page as markdown button though.
File should be updated with the new flows for accessing the MD pages.
Member
Author
There was a problem hiding this comment.
this file looks like it was an LLM artifact? i didnt look at it, but is this actually supposed to be in the repo? (its a markdown file in a scripts directory is why i ask)
dcramer
added a commit
that referenced
this pull request
Jan 20, 2026
) Moves LLM documentation from `scripts/LLM_MARKDOWN_SERVING.md` to the contributing guide at `docs/contributing/pages/llm-support.mdx`. The old file was an implementation-focused artifact from #16023 that lived in an odd location and was incomplete (missing `.md` extension access method, per feedback from @BYK and @codyde). The new page covers our broader approach to designing docs for LLMs: - Principles (ties to existing minimalist/accuracy approach) - How we support LLMs (content negotiation, copy button, navigation) - Writing considerations for contributors Refs #16023 Co-authored-by: Claude <noreply@anthropic.com>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
Serve markdown content inline when clients request
Accept: text/markdown, instead of redirecting to.mdURLs. This enables proper HTTP content negotiation for LLM/AI clients.Changes
Middleware: Switch from
redirect()torewrite()so markdown is served at the same URL.Sitemap generation: Generate hierarchical navigation for LLM discovery:
Testing