release-docs

You can automate developer documentation generation by querying a target RPC endpoint to fetch release metadata, auto-detecting the release type, and deriving versioned content from the matching git tag to produce Docusaurus version snapshots.

Querying an RPC endpoint works by fetching node and contract information, then parsing the returned version string to auto-detect the release type. This mechanism ensures the generated documentation matches the exact network state for devnet, testnet, or mainnet releases.

Generating API references and CLI docs requires deriving content from the correct git tag, bootstrapping dependencies, and running generation scripts. This updates developer version configs, produces Aztec.nr, TypeScript, and Node RPC docs, and regenerates CLI references from installed CLI output.

Yes, you need a consistent versioning setup with the installed Aztec CLI to generate release documentation. The Skill requires correct dependency bootstrapping and uses the installed CLI output to regenerate CLI reference docs accurately for the target release.

Handling migration notes and missing contract addresses involves triaging existing migration notes for updates and resolving absent contract addresses within the documentation. The workflow automates these maintenance tasks before cutting the final versioned snapshots.

If the release type is ambiguous or a risky cleanup step is detected on the next branch, the workflow pauses and requires user confirmations. This safeguard prevents errors during pre-releases, backport checks, and destructive repository cleanups.