api-doc-comments

Official

Craft precise Rust API docs for contract schemas.

Authoraxone-protocol
Version1.0.0
Installs0

System Documentation

What problem does it solve?

The API surface of Rust CosmWasm contracts often lacks consistent, domain-focused documentation. This skill guides writers to produce precise, semantics-driven doc comments for all public schema-facing items so generated contract docs are accurate and useful.

Core Features & Use Cases

  • Document all schema-facing public items: messages, enums, and every public field with clear semantics.
  • Explain preconditions, encoding formats, and domain-specific behavior to ensure the generated docs reflect real usage.
  • Support the doc-generation workflow by aligning comments with the contract surface (Instantiate/Execute/Query/Response types) across modules.

Quick Start

Write precise, domain-aware doc comments for every public schema item in a contract and regenerate the docs.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-doc-comments
Download link: https://github.com/axone-protocol/contracts/archive/main.zip#api-doc-comments

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.