Add llms.txt file for better LLM integration

[xyb]

Description

It would be very helpful to use this tool with LLMs if Rio provided an llms.txt file. This would enable better AI assistance and understanding of the codebase structure.

For more details about the llms.txt standard, please see:

• https://llmstxt.org/
• https://llmstxt.site/

The llms.txt file is a standardized format that helps AI models better understand project structure, conventions, and context, making AI-assisted development more effective.

Suggested Solution

No response

Alternatives

No response

Additional Context

No response

Related Issues/Pull Requests

No response

[mad-moo]

This looks interesting! Are there any AI agents that already make use of these files?

[iwr-redmond]

You can add llms.txt files into Aider using AiderDesk's web scraping feature.

[mad-moo]

@xyb ?

[xyb]

@mad-moo This file isn’t meant to be used by AI agents directly. Instead, it’s designed to help large language models better understand and use the tool when you provide the llms.txt URL in your prompt. In my experience, just sharing the link allows the AI to read and apply the instructions correctly.

[mad-moo]

Got it. And are you asking for a llms.txt for Rio itself (so on the Rio website), or for apps created with Rio?

[xyb]

@mad-moo I'm suggesting a llms.txt specifically for Rio itself, ideally hosted on the official Rio website. This would help LLMs better understand how to use Rio correctly, as not all models are fully familiar with it yet. Having a structured reference would improve the accuracy and relevance of AI-generated guidance related to Rio.

[iwr-redmond]

There is a GitHub Action that may be useful for this task.

[iwr-redmond]

Here is a long format example for NiceGUI.

[VanegasDataSystems]

here's the link for FastHTML's discussion of their llm.txt... short and sweet.

https://fastht.ml/docs/#getting-help-from-ai

[mad-moo]

I'd be happy to host the file. Has anybody perhaps already created one for their personal use?

[iwr-redmond]

I have not, but you may wish to consider combining the Github Action with a free API key as a trial.

h/t @HakAl for the API key research

[mad-moo]

Nice one! I'm sure a hand written one would be perfect, but that's a great start

[iwr-redmond]

LLMs exhibit a strong preference for their own output (Panickssery et al, 2024), so a hybrid approach where a LLM summarizes human-written documentation may end up putting more arrows in your quiver.