Integration Guides and Tutorials
Purpose: Route engineers to the right practical Octant v2 guide quickly. Audience: Developers who already know the kind of integration they want to build. Level: Beginner Source of truth:
[email protected]for contract behavior, this section for workflow routing. Use this page when: you need the shortest path to the right tutorial or workflow page. Do not use this page for: exact function signatures, initializer details, or production assertions without checking the contract reference and pinned source.
This section routes you to the right implementation page. It does not override the pinned core source or the autogenerated contract reference.
This section is the practical layer of the Octant v2 docs. Start here when you want a workflow, a concrete example, or a recommended reading order. Move to the autogenerated Smart Contracts pages when you need exact function signatures, roles, events, or edge-case behavior.
Start here if you want a task, not a theory page
| I need to... | Start here |
|---|---|
| build my first strategy fast | Hello World Strategy |
| understand which docs to read in what order | Common Developer Workflows |
| wire several strategies into one vault | Multi-Strategy Vaults |
| operate staking, rewards, and contribution flows | Regen Staker |
| route one yield stream to several fixed recipients | Payment Splitter Patterns |
| build a YDS using the starter template | How to Create a YieldDonating Strategy |
| understand the contract pages before diving in | Reading the Smart-Contract Reference |
What this section covers
First strategy path
- Hello World Strategy — zero to a fork-tested sDAI strategy in one page.
- How to Create a YieldDonating Strategy — a fuller starter-template path for YDS builders.
- Strategy Development Example — a worked example that complements the deeper architecture pages.
System integration path
- Multi-Strategy Vaults — strategy queues, allocation limits, and debt management.
- Payment Splitter Patterns — fixed downstream routing for multiple recipients.
- Regen Staker — staking, rewards, compounding, and contribution flows.
- Common Developer Workflows — task-based reading orders across the docs set.
Reference bridge
These guides explain what you are trying to do and why. The autogenerated contract pages explain how the relevant contracts are shaped.
- Start with a guide in this section.
- Then use Reading the Smart-Contract Reference to jump to the exact contract page you need.
- Keep both pages open when you work. The guide provides the workflow. The reference page provides the exact ABI-level detail.