Skip to content

feat(docs): enhance llms.txt with overview, data models, short flags, and defaults#67

Merged
andrasbacsai merged 3 commits intocoollabsio:v4.xfrom
toanalien:feature/add-llms-config
Mar 30, 2026
Merged

feat(docs): enhance llms.txt with overview, data models, short flags, and defaults#67
andrasbacsai merged 3 commits intocoollabsio:v4.xfrom
toanalien:feature/add-llms-config

Conversation

@toanalien
Copy link
Copy Markdown
Contributor

Enhances the machine-readable llms.txt with comprehensive documentation for AI agents, and improves the coolify docs llms generator.

Changes

llms.txt

  • Add project overview, installation instructions, and authentication guide
  • Add configuration details and output format documentation
  • Add command aliases reference (e.g., db for database, svc for service)
  • Add supported database types list
  • Add practical usage examples for common workflows
  • Add API behavior notes (UUID-only identifiers, env sync semantics, default values)
  • Add data model documentation for all 12 resource types (Application, Database, Service, Server, Project, Deployment, Resource, Private Key, Team, Team Member, GitHub App, Environment Variable, Storage)

docs generator (cmd/docs.go)

  • Output short flags alongside long flags (e.g., --force (-f))
  • Output non-trivial default values (e.g., --format defaults to table, --lines defaults to 100)

… 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.
@toanalien toanalien force-pushed the feature/add-llms-config branch from a3c7e35 to 528b135 Compare March 27, 2026 06:52
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.
@andrasbacsai
Copy link
Copy Markdown
Member

Thank you for the PR! 💜

@andrasbacsai andrasbacsai merged commit 4ae6065 into coollabsio:v4.x Mar 30, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants