Skip to content

Generate LLM friendly files for Improved LLM Integration #193

@dunhamjared

Description

@dunhamjared

Feature Request

This issue proposes LLM friendly files for the documentation repository, adhering to the llmstxt.org standard.
This would mirror the approach used by projects like Svelte 5.

Problem

Currently, LLMs and related tools often struggle to effectively parse and utilize the documentation.

This can lead to outdated or inaccurate information being presented in LLM-powered applications, hindering developers who rely on these tools. For example, LLMs might be limited to older versions of the documentation, preventing them from providing up-to-date guidance on the latest AdonisJS features.

Benefits

Some of the benefits I could think of include:

  • Better LLM Integration:
    LLMs can more easily access and process our documentation.
  • Improved Developer Experience:
    Developers using LLMs will have more accurate and up-to-date information.
  • Increased Adoption:
    Improved LLM integration can lead to greater discoverability of AdonisJS.
  • Easier Integration with LLM Tools:
    Developers building LLM-powered tools can easily incorporate AdonisJS documentation.

Notes

I believe this change would be highly beneficial for both developers and the AdonisJS community.
I'm happy to contribute to this if it seems like a worthwhile idea. :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions