Adding /llms.txt Support to AdonisJS Documentation

[0xtlt]

As language models (LLMs) like ChatGPT, Claude, and others become increasingly important tools for developers, I believe AdonisJS could benefit from implementing the /llms.txt standard to improve how these AI systems understand and interact with our documentation and codebase.

https://llmstxt.org/

What is /llms.txt?

The /llms.txt file is an emerging standard proposed in late 2024 to help language models better understand website content. Similar to how robots.txt guides search engines, llms.txt provides structured information for AI models, allowing them to more accurately reference and interpret website content. The file uses Markdown format and follows a specific structure that is both human-readable and machine-parseable.

Why AdonisJS Should Consider Implementing /llms.txt

AdonisJS has excellent documentation, but developers increasingly rely on AI coding assistants that may struggle to efficiently parse and understand the framework's structure without additional guidance. Adding a /llms.txt file could offer several benefits:

1. Enhanced Developer Experience: When developers ask LLMs about AdonisJS features or implementation details, the models would provide more accurate information based on the structured guidance in the llms.txt file.

2. Reduced Misunderstandings: By clearly outlining the framework's architecture, naming conventions, and best practices, we could minimize the likelihood of LLMs generating incorrect code or misleading advice about AdonisJS.

3. Framework Discoverability: As more developers use AI tools for technology selection and learning, a well-crafted llms.txt could help AdonisJS stand out by making its features and advantages more accessible to AI-assisted exploration.

4. Community Support: Making framework documentation more AI-friendly could reduce repetitive questions in community forums, as developers could get more accurate answers directly from their AI assistants.

Implementation Considerations

The implementation could be relatively straightforward and might include:

1. Creating a central /llms.txt file at the root of the documentation site with an overview of the framework, key concepts, and architecture.

2. Providing Markdown versions of documentation pages (appending .md to URLs, as recommended by the standard).

3. Including links to essential reference documentation, organized by categories like routing, database, authentication, etc.

4. Adding guidance for LLMs on AdonisJS coding conventions and best practices.

The work required should be minimal compared to the potential benefits, especially since AdonisJS documentation is already well-structured and comprehensive. We could focus on creating the main llms.txt file and perhaps generating Markdown versions of key documentation pages.

Other Frameworks' Approaches

Several projects have already adopted or are considering the /llms.txt standard.
Like https://daisyui.com/llms.txt & https://shopify.dev/llms.txt

[RomainLanz]

Related: adonisjs/v6-docs#193

[0xtlt]

woops I checked the discussions only!

[thetutlage]

Are there any specific tools used by these projects to generate the llms.txt file or is it all hand-written?