add llms.txt file for easier use with llms#157
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds an llms.txt entrypoint to the VuePress public assets to provide an LLM-friendly, curated index into the DSF documentation and key resources (concepts, operations, troubleshooting, and process plugin development).
Changes:
- Add a new
docs/src/.vuepress/public/llms.txtfile containing a structured overview and deep links into DSF docs. - Organize links by major areas (Core Concepts, Use Cases, Operations, Troubleshooting, Development, Community).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot stopped work on behalf of
schwzr due to an error
March 31, 2026 18:24
Copilot stopped work on behalf of
schwzr due to an error
March 31, 2026 18:24
reduced the number of places to hold the version list
Provides a structured index of all DSF documentation pages following the llms.txt standard (https://llmstxt.org), making the site easier to consume for AI tools and large language models. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contains the full text of all current documentation pages (v2.0.2) stripped of frontmatter, for LLMs that prefer ingesting complete content at once. Companion to llms.txt which provides the index. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Use version-agnostic descriptions and rely on /operations/latest links instead, so the files don't become stale on new releases. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The llms files were hand-maintained and had already drifted from the docs
(missing v2.1.0 pages, stale links). Replace manual upkeep with a
reproducible generator so they stay current.
- scripts/llms-index.ts: curated editorial source (sections, titles,
descriptions, ordering) plus a fullExtra list for pages that belong in
the full-text export but not the concise index
- scripts/generate-llms.ts: renders both files from the index and the
markdown sources; maps /latest/ to the current latestVersion, strips
frontmatter and resolves {{release.*}} tokens via the shared
replaceReleaseTokens plugin. Supports --check for CI.
- npm run docs:generate-llms (tsx pinned as a devDependency)
- Regenerated llms.txt (adds Image Verification and Hardening Measures)
and llms-full.txt (119 pages, all release tokens resolved)
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
schwzr
force-pushed
the
156-add-llmstxt-file-for-easier-use-with-llms
branch
from
8e8f4bd to
9d18445
Compare
jaboehri
approved these changes
Jun 1, 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
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.
Uh oh!
There was an error while loading. Please reload this page.