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

[Docs] Generate llms.txt Documentation for Improved LLM Accessibility #50072

Open
crypdick opened this issue Jan 26, 2025 · 0 comments
Open

[Docs] Generate llms.txt Documentation for Improved LLM Accessibility #50072

crypdick opened this issue Jan 26, 2025 · 0 comments
Labels
docs An issue or change related to documentation enhancement Request for new feature and/or capability triage Needs triage (eg: priority, bug/not-bug, and owning component)

Comments

@crypdick
Copy link
Contributor

Description

As LLMs increasingly contribute to code generation, debugging, and library usage, documentation ought to be machine-readable in addition to human-readable. The current documentation is not efficiently parsable by LLMs, which degrades performance of coding co-pilots and also makes it harder for future LLMs to be trained on Ray documentation.

Proposed Solution
Adopt the llms.txt convention to generate a standardized llms.txt file alongside existing documentation. This file would:

  1. Provide a succinct, structured library documentation that is easily parsable by co-pilots.
  2. Back-populated for previous library versions to ensure AI agents can reference version-specific documentation.

Use case

  • LLM-Centric Development: By formatting documentation for LLMs, we reduce “hallucinations” and errors in AI-generated code, improving developer productivity. By having version-accurate llms txt files, we help co-pilots reliably code for any Ray version.
  • Future-Proofing: by making our technical content easy to parse by LLMs, we ensure that future models have a better understanding of the Ray library.
  • Automating tutorial maintenance: adopting this standard would make it easier to create self-healing tutorials, where agents automatically submit pull requests that fix tutorials when we make breaking changes to our API.
@crypdick crypdick added enhancement Request for new feature and/or capability triage Needs triage (eg: priority, bug/not-bug, and owning component) labels Jan 26, 2025
@jcotant1 jcotant1 added the docs An issue or change related to documentation label Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation enhancement Request for new feature and/or capability triage Needs triage (eg: priority, bug/not-bug, and owning component)
Projects
None yet
Development

No branches or pull requests

2 participants