crane-natspec

Community

NatSpec-ready Solidity docs with AsciiDoc.

Authorcyotee
Version1.0.0
Installs0

System Documentation

What problem does it solve?

NatSpec and AsciiDoc include-tags enable structured, extractable documentation for Solidity contracts, but teams often struggle with consistent tagging and cross-referencing.

Core Features & Use Cases

  • Standardized NatSpec tagging for functions, errors, events, and interfaces.
  • AsciiDoc include-tags to facilitate modular documentation extraction.
  • Guidance, examples, and validation patterns for canonical and custom tags.

Quick Start

Annotate a Solidity function with NatSpec and include-tags to generate ready-to-publish documentation.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: crane-natspec
Download link: https://github.com/cyotee/cyotee-claude-plugin-crane/archive/main.zip#crane-natspec

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 223,000+ vetted skills library on demand.