Understand the project
Practical overview
When it fits
Use it when you need Chainlink-specific technical guidance, tutorials or illustrative code while developing a decentralized application or operating a node.
Who it is for
- Smart-contract developers integrating Chainlink products and services.
- Chainlink node operators seeking technical guidance.
- Contributors improving the documentation or adding tutorials.
Documented uses
- Learn how to interact with Chainlink systems for application integration.
- Consult tutorials and code samples while developing decentralized applications.
- Contribute documentation improvements or tutorials.
- Run the documentation repository's local development environment.
Before you choose
Requirements & limits
- The documentation source is open source and uses MDX; content files are stored as Markdown in
/src/content. - Code samples are examples, may omit checks or error handling, and are not audited; the repository cautions against production use without independent review and appropriate best practices.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Source-based practical guide
Start the documentation site locally
Run the repository's local documentation development environment.
Before you start
- A local copy of the smartcontractkit/documentation repository.
- npm.
Steps
Open a terminal in the repository directory.
Run the command below.
npm install && npm run dev
Expected outcome
The repository's local development environment starts.
Guide limitations
- The README does not specify additional runtime versions or local access details.
Evidence and transparency
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 17 October 2026
- Original website title
- smartcontractkit/documentation · Official homepage title · retained in its source language