ci: Implement llms.txt automation#659
Open
ahuseyn wants to merge 1 commit into
Open
Conversation
…omation Co-authored-by: Copilot <copilot@github.com>
|
5 tasks
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.
Description
llms.txtis a convention for exposing structured, LLM-readable documentation for AI tools and coding agents.This PR adds a GitHub Actions workflow that automatically regenerates
llms.txtand commits it to the PR branch whenever a pull request touching relevant files is opened or updated. Reviewers always see the final output as part of the changes before merge. Fork PRs are safely skipped. Manual runs are also supported via workflow dispatch.The generation script is also added alongside the workflow file. The script generates llms.txt at the repo root by crawling the plugins, packages, docs, and examples directories and building a structured markdown index of links with descriptions. For each entry it extracts a title and description from the relevant README or index.md, then writes formatted bullet-point entries pointing back to the source files on GitHub.
Related Issue
#461
Dependant PRs
Type of Change
How Has This Been Tested?
Screenshots
Checklist