Substrate Documentation¶
Substrate’s documentation is organized by intent instead of repository history.
Navigate by Goal¶
Getting Started¶
Use this section when you need to run the stack, understand local ports, or validate a fresh environment.
- Start here:
getting-started/index.md - Local setup details:
getting-started/local-development.md
Product¶
Use this section to understand what Substrate is, who it serves, how it is positioned, and where the marketplace fits.
- Start here:
product/index.md
Architecture¶
Use this section to understand system design, module structure, API boundaries, detailed design documents, and service concepts.
- Start here:
architecture/index.md
Roadmap¶
Use this section for milestones, non-functional requirements, user-story planning, and definition-of-done material.
- Start here:
roadmap/index.md
Delivery¶
Use this section for dated implementation plans and design specs that drive active work.
- Start here:
delivery/index.md
Documentation Rules¶
- Product positioning belongs under
product/ - System design belongs under
architecture/ - Forward-looking planning belongs under
roadmap/ - Dated execution docs belong under
delivery/ - Local runbook content belongs under
getting-started/
The repository root README.md remains the fastest entry point for clone, bootstrap, and deployment context.