doc-generation

Name: doc-generation
Availability: InStock
Author: Axone

Regenerate contract schemas and Markdown docs from Rust API types.

124|19|Updated Jul 11, 2022

Search Tags:#automation #documentation #rust #schemas #docs-regeneration #cargo-make

Ready to run

npx skills add https://github.com/axone-protocol/contracts --skill doc-generation-axone-protocol

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-generation
Source: https://github.com/axone-protocol/contracts/tree/main/.agents/skills/doc-generation
Command: npx skills add https://github.com/axone-protocol/contracts --skill doc-generation-axone-protocol

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Regenerates contract schemas and rendered Markdown docs directly from Rust types and metadata, ensuring documentation stays in sync with code and contract interfaces.

Core Features & Use Cases

Automates the regeneration of schemas and docs via cargo make docs, keeping generated artifacts in sync with code changes.
Detects drift between code metadata and rendered docs to streamline accurate publication.
Supports preparing documentation commits with consistent, regenerated outputs.

Quick Start

Run cargo make docs to regenerate all contract schemas and rendered Markdown docs.

Frequently Asked Questions about doc-generation

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

FAQPage Schema

How do I regenerate contract schemas and Markdown documentation from Rust code?▼

You can regenerate contract schemas and Markdown documentation from Rust code by running the cargo make docs command, which refreshes generated artifacts across the repository to stay in sync with API changes.

What is the best way to detect drift between Rust API types and rendered docs?▼

Detecting drift between Rust API types and rendered docs is handled by regenerating schemas and Markdown via cargo make docs, allowing you to compare current code metadata against previously published documentation outputs.

How does automatic documentation regeneration work with cargo make docs?▼

Automatic documentation regeneration with cargo make docs works by reading Rust API types and schema metadata, then outputting updated contracts/*/schema and docs/*.md files across AXONE contracts in the repository.

Can I use this to prepare documentation commits for AXONE contracts?▼

Yes, you can use this to prepare documentation commits for AXONE contracts by running the end-to-end pipeline to regenerate consistent schema and Markdown outputs before committing the updated files.

Does regenerating contract schemas require any specific Rust dependencies or environments?▼

Regenerating contract schemas requires a Rust environment with cargo make installed to execute the docs task, reading existing schema metadata and docs to produce updated schema and Markdown artifacts.