docs: add llms.txt and llms-full.txt for v5 documentation#3041
Open
tamish560 wants to merge 4 commits into
Open
docs: add llms.txt and llms-full.txt for v5 documentation#3041tamish560 wants to merge 4 commits into
tamish560 wants to merge 4 commits into
Conversation
Contributor
|
Should it concentrate so much on migration? would not |
Author
|
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. |
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.
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/)