Practical overview
When it fits
Use Docs when seeking project documentation for the @polkadot family or when contributing corrections and additions.
Who it is for
- Developers looking for documentation about @polkadot tools and libraries.
- People contributing to the project’s documentation.
Documented uses
- Consult documentation for the @polkadot family of tools and libraries.
- Report gaps or questions about documented areas through a GitHub issue.
- Propose documentation changes with a pull request.
Requirements & limits
The latest documentation version is published at polkadot.js.org/docs. The documentation repository is public and licensed CC0-1.0.
- The portal covers the @polkadot family of tools and libraries; it is documentation rather than an executable tool or software API.
- The project accepts documentation feedback as GitHub issues and proposed changes as pull requests.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Find Polkadot.js developer documentation
Locate documentation for JavaScript tools, utilities, and libraries for interacting with Polkadot.
Before you start
- A web browser.
Steps
Open https://polkadot.js.org/docs/.
Browse the developer-focused documentation for the Polkadot.js family of tools and libraries.
Expected outcome
You can access the documentation portal for Polkadot- and Substrate-related developer libraries.
Guide limitations
- The documentation focuses on developer libraries; it is not itself a software API or executable tool.
- The portal directs end users seeking network interaction to separate Polkadot/Substrate or IPFS applications.
Report a documentation gap or propose a contribution
Raise a documentation issue or contribute a change to the polkadot-js documentation repository.
Before you start
- A web browser.
- A gap or uncertainty to report, or a proposed documentation change.
Steps
Open the polkadot-js/docs repository at https://github.com/polkadot-js/docs.
For a gap or question, log an issue; alternatively, make a pull request with a proposed change.
Expected outcome
You can submit feedback through an issue or propose a documentation change through a pull request.
Guide limitations
- The source describes these contribution routes but does not document submission details or review outcomes.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 13 October 2026
- Original website title
- polkadot-js/docs · Official homepage title · retained in its source language