[Feature request] automatic `sections` generation based on `README.md` file

[gbyesiltas]

Hey!

I was thinking about adding this module to our project, but I didn't like the idea of duplicating documentation between a README.md file and the sections in the llm module options. It would be great if the module would be able to generate it automatically based on titles/sections on readme files :)

Thanks!

[atinux]

Hi @gbyesiltas

I believe this should be quite easy to do in your nuxt.config.ts or with a module to read the README.md and add it to the llms config

[gbyesiltas]

@atinux Hey, thanks for the reply :)

I believe this should be quite easy to do in your nuxt.config.ts

if you mean to manually add it, yes it would be easy but having to keep two documentations in sync wouldn't be great and it could sort of bloat the nuxt.config.ts file

with a module to read the README.md and add it to the llms config

exactly! I was hoping it could be introduced as a feature to this module but otherwise we can also implement it ourselves :)

Update: well actually, I think I generally misunderstood what the llm.txt file is supposed to be for. I thought it was for the code-assistant LLM's, but it's more for the LLM's that will interact with the final website UI. In this case, this wouldn't really be much of a concern since we already don't have an existing readme file for this purpose :D I was more thinking about re-using the readme for other developers for the code-assistant llm's.