Add llms.txt for LLM-friendly documentation discovery - #2208
Open
abyworkings-coder wants to merge 1 commit into
Open
Add llms.txt for LLM-friendly documentation discovery#2208abyworkings-coder wants to merge 1 commit into
abyworkings-coder wants to merge 1 commit into
Conversation
Adds an llms.txt file per the emerging llms.txt standard (https://llmstxt.org), providing a curated, machine-readable index of delta's documentation pages to help LLM-based tools find and cite the right docs.
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
1 participant
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 repo root, following the emerging llms.txt standard.Why
llms.txtis a curated, machine-readable index of a project's documentation, designed to help LLM-based tools (coding assistants, chat agents, search) find and cite the right pages instead of guessing or hallucinating. delta already has a well-structured mdBook manual deployed at https://dandavison.github.io/delta/ — this file just indexes it.What's included
All 36 pages from the manual's
SUMMARY.md/live site nav, each with a one-line description: introduction, get started, features, installation, configuration, environment variables, usage (including all sub-pages: colors, line numbers, hyperlinks, side-by-side, grep, features, custom themes, diff-highlight/diff-so-fancy emulation, --color-moved, navigation keybindings, merge conflicts, git blame, supported languages/themes), tips & tricks (including all sub-pages), comparisons with other tools, building from source, related projects, full --help output, and screenshot configs.Every URL was checked and returns 200. Validated against llms-txt-lint.
Test plan