You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: