feat: add llms.txt for better LLM usage#492
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an llms.txt file at the repository root to provide a concise, machine-readable description of Image Factory concepts, HTTP/PXE/OCI endpoints, and example usage for automated LLM discovery.
Changes:
- Introduces
llms.txtdescribing core Image Factory concepts (schematics, versions, models) and a typical workflow. - Documents key HTTP/PXE/OCI endpoints and enterprise-only APIs, with example
curl/dockercommands.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Do we need to write this down? It will become obsolete each time we update docs. If this is needed, maybe we can serve it from Image Factory itself on |
That was the goal and I forgot to also push those changes. I just added a handler for /llms.txt with the text returned. |
Adds the file to the root path for automatic discovery and helping LLMs discover endpoints and usage. Signed-off-by: Justin Garrison <justin.garrison@siderolabs.com>
|
The lint check failures are not because of this PR. |
There was a problem hiding this comment.
Can we render this on build? This is technically just a docs/API.md with some minor changes, right?
There was a problem hiding this comment.
Yes, it's just a raw text endpoint. I'm not sure what the difference would be with rendering on build vs embedding. Happy to do it a different way, I just wanted something that was easier for discovery and usage.
Adds the file to the root path for automatic discovery and helping LLMs discover endpoints and usage.