Skip to content

docs: Add llms.txt and llms-full.txt #4603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 13, 2025
Merged

docs: Add llms.txt and llms-full.txt #4603

merged 9 commits into from
Jul 13, 2025

Conversation

KrzysztofMoch
Copy link
Collaborator

@KrzysztofMoch KrzysztofMoch commented Jul 13, 2025

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.

  • Generates llms.txt: Creates a concise overview of the project, including features, project status, key concepts, and usage examples.
  • Generates 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

@KrzysztofMoch KrzysztofMoch merged commit 31915e4 into master Jul 13, 2025
8 checks passed
@KrzysztofMoch KrzysztofMoch deleted the docs/llms-txt branch July 13, 2025 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants