feat(docs): enhance llms.txt with overview, data models, short flags, and defaults#67
Merged
andrasbacsai merged 3 commits intocoollabsio:v4.xfrom Mar 30, 2026
Merged
Conversation
… and defaults Add comprehensive header to llms.txt including installation, authentication, configuration, command aliases, usage examples, API notes, and data model documentation. Update docs generator to output short flags and default values.
a3c7e35 to
528b135
Compare
Refactor `docs` generation to split intro/body content and build the `Command Aliases` section dynamically from Cobra commands instead of a hardcoded list. Add `cmd/docs_test.go` coverage for: - alias extraction from nested command trees - flag rendering with shorthand and default values Regenerate `llms.txt` to reflect the new alias output and updated docs.
Member
|
Thank you for the PR! 💜 |
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.
Enhances the machine-readable
llms.txtwith comprehensive documentation for AI agents, and improves thecoolify docs llmsgenerator.Changes
llms.txt
dbfordatabase,svcforservice)docs generator (
cmd/docs.go)--force (-f))--formatdefaults totable,--linesdefaults to100)