Loading…
Guide for writing Rust doc comments that produce accurate generated contract documentation. Use when editing Instantiate/Execute/Query/Response types or any public schema-facing API.
api-doc-comments is an agent skill entry in ChatHome Skills, sourced from GitHub Skill Search and scored 58/100. # API Doc Comments ## Core Rule The generated documentation is only as good as the Rust doc comments on schema-facing types. Write the comments on the source ty. As an agent skill, it packages a reusable instruction set that AI coding agents such as Codex and Claude Code can load to perform this task without hand-written glue code. ChatHome Skills discovered this entry through its daily ingest of official registries and GitHub discovery queries, and re-verifies repository facts, freshness signals, and install metadata on every run. The quality score weighs official-registry presence, a working install command, license clarity, GitHub star trajectory, and repository freshness — the full formula is on the Sources page. The install command above is ready to copy. Review the last-pushed date and repository status before adding api-doc-comments to a production agent workflow; the snapshot facts below are point-in-time values from the most recent ingest.
codex skill install axone-protocol/contractsReview the upstream source before running this command.
Scan coverage: Install metadata and the indexed document body.
Automated signals from install metadata and a bounded skill body — not a full code security audit and not a recursive source or dependency review.
# API Doc Comments ## Core Rule The generated documentation is only as good as the Rust doc comments on schema-facing types. Write the comments on the source types first, then rege