release-network-docs

Update Aztec network and operator docs for a mainnet or testnet release.

Updated May 14, 2026
One-click install
npx skills add https://github.com/HabibTorjmen/Blockchain --skill release-network-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-network-docs
Source: https://github.com/HabibTorjmen/Blockchain/tree/main/aztec-packages/.claude/skills/release-network-docs
Command: npx skills add https://github.com/HabibTorjmen/Blockchain --skill release-network-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps Aztec network/operator documentation accurate for each mainnet or testnet release by automatically pulling the latest version and contract addresses from the provided JSON-RPC endpoint, then rebuilding and versioning the operator docs without changing developer documentation.

Core Features & Use Cases

  • Detects the correct release type (mainnet vs testnet) from the node version string returned by the RPC, and aborts on devnet/nightly usage.
  • Regenerates and snapshots operator documentation by updating network and contract address tables, optionally incorporating operator content changes, regenerating the versioned Node JSON-RPC API reference, and producing a versioned docs snapshot.
  • Updates network version configuration and cleans old versions so versioned docs mappings remain consistent on next.
  • Use case: You are preparing a new mainnet or testnet release and need contract address updates plus regenerated network/operator docs for the new tag, while leaving developer docs untouched.

Quick Start

Run the release-network-docs skill with your target node RPC URL to update, build, validate, and cut versioned network/operator documentation for that release.

Frequently Asked Questions about release-network-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update network operator documentation for a specific mainnet or testnet release?

You can update network operator docs by providing a live JSON-RPC endpoint to derive the release version and contract addresses, then automatically rebuilding and snapshotting the versioned documentation for that release.

How does RPC address resolution work for generating versioned docs?

RPC address resolution works by querying a live JSON-RPC endpoint to detect the node version and extract L1/L2 contract addresses, which are then injected into network configuration and versioned documentation artifacts.

Can I use this skill to generate documentation for a devnet or nightly release?

No, this skill cannot be used for devnet or nightly releases. It detects the release type from the node version string returned by the RPC and explicitly aborts when it encounters devnet or nightly environments.

How do I resolve missing contract addresses when rebuilding Docusaurus versioned docs?

Missing contract addresses are resolved automatically through on-chain queries or deployment outputs, ensuring the L1/L2 contract address tables in the Docusaurus versioned docs are accurate before rebuilding and validating.

Does updating network operator docs also modify developer documentation?

No, updating network operator docs leaves developer documentation untouched. The skill specifically targets network version configuration, contract address tables, and the Node JSON-RPC API reference without changing developer documentation.

What's the best way to keep L1 and L2 contract address tables consistent across versioned docs?

The best way to keep contract address tables consistent is to derive them directly from the live RPC endpoint, update the network version configuration, and clean old versions so the versioned documentation mappings remain aligned on next.