Welcome to Chainlink developer documentation repository. This repository is the source for developer documentation on docs.chain.link, which is a resource for smart contract developers and node operators building decentralized applications on several networks.
This documentation is open source. If you want to contribute tutorials or improvements, see the Contributing guide.
Note
The code samples in this documentation are examples for using Chainlink products and services and are provided to help you understand how to interact with Chainlink's systems and services so that you can integrate them into your own. These templates are provided "AS IS" and "AS AVAILABLE" without warranties of any kind, have not been audited, and may be missing key checks or error handling to make the usage of the product more clear. Do not use the example code in a production environment without completing your own audits and application of best practices. Neither Chainlink Labs, the Chainlink Foundation, nor Chainlink node operators are responsible for unintended outputs that are generated due to errors in code.
To run a local development environment, use the following command:
npm install && npm run dev
- All docs are markdown and stored in
/src/content. - Navigation is JSON in
/src/config/sidebar.ts
This repo is configured to automatically create a preview environment on Vercel when a PR is opened. After the deployment is approved, the Vercel bot will leave a comment with a link to the preview on your PR.
This repo is configured to automatically update the production (https://docs.chain.link) site when commits are pushed to the main branch.