graycoreio
LLMs.txt
Summary
A proper LLMs.txt with api docs and project to help AI dev.
Affected documentation page
daff.io/docs/llms
Daffodil version
latest
@DavidGOrtega I am unfamiliar with LLMS.txt, do you have a reference for it?
Sure. Typically Its a markdown version of the docs for LLM ingestion via plain file or MCP. Look here I can do a PR. We just need a workflow job to check the repo and do a new PR every time you do a release. Something like FireCrawl, Jina or other can convert the official docs into markdown and save into LLMs.txt and LLMs-full.txt files.
Very useful to code with the LLM as it knows the packages, components, etc...
@Buddhsen-tripathi sure. We already have a lot of docs generated (most docs are already even in markdown format).
I don't think that we need any additional workflows. We should be able to aggregate all the existing docs into whatever format necessary via some modifications @daffodil/tools-dgeni.
@DavidGOrtega how would you suggest inserting API documentation (think JSDoc format for all of the functions/types in the codebase)?
I understand also on a side note, I've added a PR for sitemap.xml generation, if possible may someone review it please.
@DavidGOrtega how would you suggest inserting API documentation (think JSDoc format for all of the functions/types in the codebase)?
Actually having the information that there is automation in generating the docs we could just follow this node.js PR where they actually generates LLMs.txt from JS docs among others
@DavidGOrtega I tried to find out the output of node's llms.txt (I looked here: https://nodejs.org/llms.txt) any chance you know where the output is?
sorry for the late reply @damienwebdev I was on holidays.
It seems that the are struggling with deployment I just pointed the repo because they ware creating it with pretty much similar tools than daffodil. let me check how it would be included in docs like:
- https://angular.dev/context/llm-files/llms-full.txt
- https://daisyui.com/llms.txt
This issue got linked on Node's repo so I got curious. You can see the output of our LLMS.txt here: https://github.com/nodejs/doc-kit/actions/runs/18631409957. Also uploaded it here: https://gist.github.com/ovflowd/428bd7f2abea36eb4140c1c60abfaa61
Yw! Appreciate the ecosystem keeping an 👀 on what we're doing. Feedback also always welcome :)