Add llms.txt - #2790
Open
abyworkings-coder wants to merge 1 commit into
Open
Conversation
Small, curated markdown index (title, summary, links to docs) so AI coding agents can understand yq quickly from the repo alone, without crawling the gitbook docs site. Content is derived entirely from the existing README (Quick Usage Guide, Features list links, Install section) — no new claims, just pointers. Validated against https://llmstxt.org with llms-txt-lint.
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.
This repo doesn't have an
llms.txtfile yet — a small, curated markdown index (title, one-line summary, and grouped links to the docs that matter) that AI coding agents can read to understand a project quickly, instead of having to crawl and guess.yq's detailed docs live on gitbook, separate from the repo. This llms.txt pulls the key usage patterns and doc links that already exist in the README's Quick Usage Guide and Features list into a repo-local index, so an agent working from the repo alone (no network access to the gitbook site, or just working faster from local files) has something self-describing to start from.
Content is derived entirely from your existing README — no new claims, just pointers, organized per the llms.txt spec's Usage / Install / Optional convention. Validated against the llms.txt spec with llms-txt-lint (disclosure: a small validator tool I maintain).
Totally understand if this isn't something you want to maintain — no worries either way, feel free to close.