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

[Enhancement]: Aggregate /all pages #2283

Open
thodges-gh opened this issue Jan 28, 2025 · 0 comments
Open

[Enhancement]: Aggregate /all pages #2283

thodges-gh opened this issue Jan 28, 2025 · 0 comments
Labels
enhancement Enhance existing content or processes triage

Comments

@thodges-gh
Copy link
Contributor

What would you like us to improve?

I see the utilization of LLMs by engineers as an essential part of software engineering going forward. A current challenge of using bleeding-edge software is that these models' training data can be up to a year old. Developers then have to provide current documentation to the models they're working with, but the models can't always "web crawl" through an entire documentation site. Therefore, I propose we create endpoints that aggregate all the information for a product on a single page, allowing developers to give the model one URL to serve it with all the relevant and latest information on how to use a particular product or service.

Add a page for any section: /all

The different sections with their own /all urls allow for a little less context (tokens) to be ingested by the LLM if the developer knows specifically which services to integrate. A top-level /all includes everything from the above on a single page, which will use lots of tokens, but may be worth just having it.

How important it is?

If the future of software development is to utilize LLMs, especially for green-field project starting, then having the most LLM-friendly documentation will position us as the favorable project for anything we support within the web3 ecosystem. A few projects do something similar to this already, like ethers, built with MkDocs. How important this is may be subjective to how impactful you feel AI-assisted development is, but I think this is an important foundational step that will allow developers to easily create projects that use Chainlink products and services.

@thodges-gh thodges-gh added enhancement Enhance existing content or processes triage labels Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhance existing content or processes triage
Projects
None yet
Development

No branches or pull requests

1 participant