fix: Copy-paste error in restaurant example (domains.md)#104
Open
southpawriter02 wants to merge 1 commit intoAnswerDotAI:mainfrom
Open
fix: Copy-paste error in restaurant example (domains.md)#104southpawriter02 wants to merge 1 commit intoAnswerDotAI:mainfrom
southpawriter02 wants to merge 1 commit intoAnswerDotAI:mainfrom
Conversation
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
1 participant
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
The Dessert Menu entry in the restaurant
llms.txtexample was described as "A subset of the Starlette docs" — a remnant from the FastHTML examples elsewhere in the repo. Replaced it with a description that's a bit more appetizing.Before:
After:
Why this matters (a little)
The
domains.mdexamples are essentially the pedagogical onramp for people figuring out how to write their ownllms.txt. When the example itself has a description that doesn't match its context, it undercuts the very point the doc is trying to make: write concise, clear descriptions for your links. Figured I'd practice what the spec preaches.I'm a tech writer with 15+ years in the industry, and I've been genuinely excited about the llms.txt spec — it sits right at the intersection of documentation craft and LLM usability, which is basically my professional sweet spot. Happy to contribute more where docs-oriented eyes would be useful.
@jph00