Repository navigation
docs: rewrite llms.txt and simplify the install steps - #245
Merged
Merged
Conversation
The old file only said the module is part of the GoGPU ecosystem. It now says what ui does, how to add it without mismatched dependency versions, and links the guides and key examples.
README and the getting-started guide told users to go get gogpu@latest and gg@latest next to ui. When those tags are ahead of the ui release, the build mixes dependency versions that do not compile together. Adding ui and running go mod tidy keeps them at the versions the ui release was built with.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Two docs changes about how people and agents find and install ui.
llms.txtwas a stub: it said ui is part of the GoGPU ecosystem and linked three pages, so an agent reading it learned nothing about what the toolkit does. The new file follows the llmstxt.org layout:helloandgallery;It has no version numbers, so it does not go stale between releases.
The README and the getting-started guide told users to
go getgogpu and gg at@latestnext to ui. When those tags are ahead of the ui release, the build mixes dependency versions that don't compile together, which is what #239 ran into. Both now say to add ui and rungo mod tidy, which keeps gogpu and gg at the versions the ui release was built with.I checked every link, and the Quick Start snippet builds with
GOWORK=offagainst the released dependencies.