Repository navigation
docs: serve markdown to AI agents - #336
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🚀 Salesforce CI✅ Deployment succeeded✅ All tests passed📦 Workflow run, logs and artifacts 📊 Stats: 1012 total | ✅ 1012 passed | ❌ 0 failed |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #336 +/- ##
=======================================
Coverage 98.82% 98.82%
=======================================
Files 4 4
Lines 2208 2208
=======================================
Hits 2182 2182
Misses 26 26
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
AI agents (ChatGPT, Claude, Perplexity, coding agents like Claude Code or Cursor) read markdown much better than rendered HTML. This gives every docs page a markdown copy and makes agents find it.
Changes in
website/:generateMarkdownFiles: truein docusaurus-plugin-llms: a.mdcopy of each current doc page next to it in the build (/soql/api/soql.md), and llms.txt now links those copies.plugins/llms-markdown.jswraps the plugin: after the copies are written, every page that has one gets<link rel="alternate" type="text/markdown">, the home page one tollms.txt. Wrapping keeps the order, Docusaurus runspostBuildhooks in parallel. Versioned pages (6.12.0) get no copy and no link.middleware.js(Vercel Routing Middleware,website/is the project root): a page requested withAccept: text/markdownanswers with its.mdcopy, the home page withllms.txt. Pages without a copy fall back to HTML..mdresponses get aLink: rel="canonical"header. Adds@vercel/functions(dev dependency).robots.txt: names the OpenAI, Anthropic and Perplexity crawlers next to*(same rules), addsContent-Signal: search=yes, ai-input=yes, ai-train=yesand points at llms.txt.Checked with
npm run build(54 pages linked, every link points at a file in the build) and on the Vercel preview:.mdandAccept: text/markdownreturn markdown, browsers still get HTML.