Skip to content

Add LLM friendly documentation (llms.txt)#103

Merged
csvance merged 5 commits into
mainfrom
llms-md
Feb 23, 2026
Merged

Add LLM friendly documentation (llms.txt)#103
csvance merged 5 commits into
mainfrom
llms-md

Conversation

@csvance

@csvance csvance commented Feb 23, 2026

Copy link
Copy Markdown
Collaborator

Since there are no public examples of using gRPCClient.jl v1.0.0 to my knowledge in real projects, its unlikely to be included as data for LLM pretraining. In order to facilitate usage of this project by LLM coding assistants, provide LLMS.md, essentially just a markdown version of the documentation produced by Documenter.jl. Since Documenter.jl does not currently support Markdown output, I forked it and used LLM assistance in order to add it just for the purposes of being able to generate LLMS.md rather than to upstream it.

Build process is not fully automated, when changing documentation LLMS.md should also be updated.
Add to generated documentation to make it easier for LLM search engines to find it
@csvance csvance changed the title Add LLM friendly documentation (LLMS.md) Add LLM friendly documentation (llms.txt) Feb 23, 2026
@csvance

csvance commented Feb 23, 2026

Copy link
Copy Markdown
Collaborator Author
  • Add llms.txt to docs/src so its included in static documentation website.
  • Also reference it in README.md

@csvance csvance merged commit 8f1a939 into main Feb 23, 2026
13 checks passed
@csvance csvance deleted the llms-md branch February 23, 2026 20:17
@codecov-commenter

codecov-commenter commented Feb 23, 2026

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.58%. Comparing base (7cfad6b) to head (ce34a3d).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #103   +/-   ##
=======================================
  Coverage   90.58%   90.58%           
=======================================
  Files           7        7           
  Lines         531      531           
=======================================
  Hits          481      481           
  Misses         50       50           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants