docs: add llms.txt and llms-full.txt for v5 documentation#3041
Conversation
|
Should it concentrate so much on migration? would not |
|
good point. the llms.txt is meant for AI assistants to understand the framework, not for human migration. I'll rework both files to describe v5 as it is and drop the v4 comparisons and migration checklist. the "v5 vs v4" annotations and the migration section at the bottom can go. the llms-full.txt has the same issue with the "Critical v5 Breaking Changes" section being framed entirely as v4-to-v5 diffs. I'll rewrite that to just describe the v5 API without the v4 references. give me a bit to update both files. |
|
@aldas reworked both files as suggested. Dropped the v4 comparisons and migration focus. Both |
|
I see if I can check this today. note to self: check also how others have done it. for example: https://angular.dev/ai/develop-with-ai#providing-context-with-llmstxt |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3041 +/- ##
==========================================
+ Coverage 93.17% 93.42% +0.24%
==========================================
Files 43 43
Lines 4501 4730 +229
==========================================
+ Hits 4194 4419 +225
- Misses 189 190 +1
- Partials 118 121 +3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
aldas
left a comment
There was a problem hiding this comment.
LGTM, hope it helps people and their LLMs
|
anyone reading this: If you feel that it can be improved then just send the PR. |
What
Adds
llms.txtandllms-full.txtto the repository root following the llmstxt.org specification.Why
AI coding assistants (Cursor, Copilot, Claude, etc.) frequently hallucinate Echo v4 syntax when users are working with v5. The v4-to-v5 breaking changes are significant (Context is now a struct, handlers use
*echo.Context, slog replaces the custom Logger, HTTPErrorHandler params swapped, etc.) and LLMs don't have accurate v5 context.llms.txtprovides a concise summary with quick-reference patterns.llms-full.txtprovides the complete v5 API surface including all breaking changes, method signatures, and migration checklist.Contents
llms.txt - Summary file with:
llms-full.txt - Full reference with:
Closes #2980 (discussion proposal by @iharshr, green-lit by @aldas).
Notes
API_CHANGES_V5.mdand actual source files (echo.go,context.go,group.go,middleware/)