Add llms.txt for AI/LLM discoverability - #2216
Open
abyworkings-coder wants to merge 3 commits into
Open
Conversation
Contributor
|
I generally don't have a problem with this but I look at it and think it's just one more thing to keep updated when the site changes. Hopefully someone can keep up with that. |
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.
What
Adds an
llms.txtfile at the site root (served from.vuepress/public/llms.txt, following the same static-passthrough convention asopensearch.xmlandicon.png), giving AI tools and LLM-based assistants a curated, low-noise index of the documentation.Why
llms.txt is an emerging convention (like
robots.txtorsitemap.xml) for giving LLM-based tools a curated entry point into a site's docs, rather than requiring them to crawl or guess through the full site. Given nushell.github.io has 700+ individual command pages and 450+ blog posts, an exhaustive dump wouldn't be useful — this file instead curates the highest-value ~80 pages: getting-started guides, core language concepts, scripting/extensibility docs, configuration, the commands index and category pages, the cookbook, and the language guide.What's included
Verified every linked URL returns 200 on the live site before opening this PR.
Test plan
llms.txt(404 before this change).vuepress/public/is the static-passthrough directory used for other root-level static files (opensearch.xml,icon.png), both live at 200