docs: Add llms.txt
and llms-full.txt
#4603
Merged
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.
Summary
Adds scripts to automatically generate documentation files tailored for Large Language Models (LLMs) and other automated systems. This enhancement provides structured, up-to-date project information and documentation.
llms.txt
: Creates a concise overview of the project, including features, project status, key concepts, and usage examples.llms-full.txt
: Compiles a comprehensive version by concatenating the main README and all detailed documentation pages.This automation ensures that LLM-friendly content remains current with codebase changes, improving AI-assisted understanding and information retrieval for developers and users.
You can access those files at:
Continuation of #4588