Getting Started
Purpose: Route new Octant v2 developers to the right first setup, address, and reference pages. Audience: Developers preparing to read, build, test, or integrate against Octant v2. Level: Beginner Source of truth:
[email protected]; for deployment addresses, the Deployed Addresses page is canonical for this docs bundle. Use this page when: you are opening the developer docs for the first time or need the shortest path to setup material. Do not use this page for: exact function signatures or contract behavior without checking the pinned source and smart-contract reference pages.
Start here when you need orientation before writing code. This section explains the docs source-of-truth rules, the tested local development paths, and the address/reference pages you should keep open while building.
First steps
| I need to... | Start here |
|---|---|
| understand the protocol shape and docs conventions | Developer Orientation |
| set up a local core or starter-template checkout | Local Development Quickstart |
| find canonical shared mainnet addresses | Deployed Addresses |
| choose a starter workflow and task path | Development Starter Pack |
| read generated ABI and contract pages correctly | Reading the Smart-Contract Reference |
Source-of-truth rules
These docs are pinned to [email protected]. Do not substitute latest branches for contract behavior unless a page explicitly tells you to re-audit against a newer revision.
For deployment addresses, use Deployed Addresses. Some team-confirmed addresses intentionally differ from older registry values in the pinned repo, and this docs bundle treats the team-confirmed rows as canonical for integrators.