This repository holds documentation that goes in the Substrate Knowledge Base. The main website is hosted in substrate-cms.
All docs are written in markdown format. The most up-to-date docs are in the current folder, while supporting figures and images go in the assets folder.
Feel free to add an issue if there is documentation that you'd like to see. See the contributing guide for guidance on making PRs.
The knowledge base has six main categories. These are not meant to be a table of contents or imposed order in which to read documentation, but rather groups of articles within the same context and for similar audiences.
- Getting Started: Entry-level documentation. For example dependencies, installation, key terms.
- Learn Substrate: Conceptual documentation. Articles about assumptions, key concepts, and design decisions in Substrate that will help you make educated decisions about developing your chain.
- Runtime: Documentation that goes more in-depth and covers topics specific to runtime development like macros, storage, fees, and pallet architecture.
- Smart Contracts: A section dedicated to smart contracts on Substrate.
- Integrate: Documentation about integrating and interacting with your chain for node operation, key management, and front-end development.
- Advanced: Sometimes you need more details than just the abstraction. The Advanced section contains information about encoding/decoding, consensus, cryptography, etc.
All documentation is under the Apache 2 License.