Add llms.txt for LLM/agent-readable project summary - #724
Open
abyworkings-coder wants to merge 1 commit into
Open
Add llms.txt for LLM/agent-readable project summary#724abyworkings-coder wants to merge 1 commit into
abyworkings-coder wants to merge 1 commit into
Conversation
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 get a quick, accurate picture of a project instead of crawling and guessing through the full README and 100+ parser doc pages.Given jc's core use case (piping command output into scripts/automation), it seemed like a natural fit for agent-assisted workflows — an agent asked "how do I parse
ifconfigoutput as JSON" can load this file and go straight to the right parser reference instead of parsing the whole README.Content is derived entirely from your existing README sections (Installation, Usage, full parser list, Compatibility, Contributing) — no new claims, just pointers into docs that already exist. Validated against the llms.txt spec with llms-txt-lint (disclosure: a small validator tool I maintain — happy to drop that line from the PR if you'd rather not have it).
Totally understand if this isn't something you want to maintain — no worries either way, feel free to close.