Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate LLM friendly files for Improved LLM Integration #193

Open
dunhamjared opened this issue Feb 3, 2025 · 1 comment
Open

Generate LLM friendly files for Improved LLM Integration #193

dunhamjared opened this issue Feb 3, 2025 · 1 comment

Comments

@dunhamjared
Copy link
Contributor

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. :)

@dunhamjared dunhamjared changed the title Generate LLM friendly files for Improved LLM Integration and AdonisJS Adoption Generate LLM friendly files for Improved LLM Integration Feb 3, 2025
@thetutlage
Copy link
Member

Hello @dunhamjared

Thanks for creating this issue. Yes, I think in today's age, we should optimize our docs for LLM integration. I will go through the shared spec in few days 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants