Agent-Assisted Development
Purpose: Teach developers how to pair effectively with coding assistants when working on Octant v2. Audience: Developers using Claude, Cursor, GitHub Copilot, or similar coding assistants alongside Octant v2 workflows. Level: Beginner to Intermediate Source of truth:
[email protected]for contract behavior; this section for assistant conventions and task card format. Use this page when: you are starting to use a coding assistant on Octant v2 work and want to understand how the docs are structured to support that. Do not use this page for: exact function signatures, ABI-level detail, or production deployment assertions — use the Smart Contracts reference for those.
Coding assistants can accelerate Octant v2 development, but only if they have the right context. A coding assistant that guesses at import paths, constructor signatures, or role boundaries will produce code that looks plausible and compiles incorrectly.
This section explains how the Octant v2 docs are structured to give coding assistants that context — and how to use that structure effectively.
What this section covers
How to Use Coding Assistants
A narrative guide to the conventions used across the docs. Covers how to load context into a coding assistant session, which files to include, how to interpret coding-assistant callouts on workflow pages, and what a productive human-plus-assistant workflow looks like on an Octant v2 task.
Task Card Format
A reference for the structured task cards that appear on workflow pages throughout the docs. Each task card gives a coding assistant a complete, scoped context block: the goal, the files to edit, the files to leave alone, required setup, verification steps, and a pointer to the anti-patterns list. This page documents the template and explains what each field means.
Agent Anti-Patterns
A list of things coding assistants must never do when working with Octant v2. Includes patterns such as hallucinating constructor arguments, hardcoding addresses instead of reading from deployed-addresses, skipping fork tests, and modifying files outside the declared scope. Link to this page from task cards and coding-assistant callouts to give assistants a concrete boundary.
Prompt Library
Copy-paste prompts for common Octant v2 tasks. Each prompt is pre-loaded with the key context a coding assistant needs — pinned commit, relevant files, expected output shape, and verification criteria. Use these as starting points, not final prompts: always adapt them to your actual task before submitting.
Workflow Manifests
A human-readable index of the machine-readable sidecars that accompany runnable setup workflows. Use this page when you want exact command sequences, required environment variables, stop conditions, expected git-status snapshots, and the starter-template re-pin helper without reconstructing them from prose.
How this section connects to the rest of the docs
The coding-assistant callouts, task cards, and annotated code-block labels that appear on workflow pages throughout these docs are designed to work with the guides in this section.
When a workflow page shows a task card, it is following the format documented in Task Card Format. When a callout says "if you are using a coding assistant, do not modify X", it is echoing the boundaries listed in Agent Anti-Patterns. When a prompt in the Prompt Library references a specific file, it is the same file the corresponding workflow page names in its task card.
Read How to Use Coding Assistants first. Then use the Task Card Format, Workflow Manifests, and the Prompt Library as you work through specific workflow pages.