motoko-doc-strings

Document Motoko public API declarations with triple-slash doc comments.

Updated Mar 19, 2026

Search Tags:#documentation #api #code-quality #motoko #doc-strings #mo-doc #public-declarations

Ready to run

npx skills add https://github.com/research-ag/motoko-skills --skill motoko-doc-strings

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: motoko-doc-strings
Source: https://github.com/research-ag/motoko-skills/tree/main/skills/doc-strings
Command: npx skills add https://github.com/research-ag/motoko-skills --skill motoko-doc-strings

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Add triple-slash doc comments to every public declaration in Motoko source files so that mo-doc renders meaningful documentation pages. This skill captures conventions used in mo:core and applies to the Motoko ecosystem.

Core Features & Use Cases

Document public declarations in Motoko modules to ensure complete API docs are generated.
Enforce consistent doc style across packages and support docs generation workflow for release/CI.
Use Case: When you add a new public type or function, this skill guides adding a corresponding doc string to keep docs in sync.

Quick Start

Instruct mo-doc to generate and verify documentation for Motoko sources.

Frequently Asked Questions about motoko-doc-strings

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

FAQPage Schema

How do I add doc strings to public declarations in Motoko?▼

You can document public declarations by adding triple-slash doc comments to every public symbol in Motoko source files. This enforces consistent doc style across packages to keep API docs in sync.

What's the best way to generate API documentation for Motoko modules?▼

The best way to generate Motoko API documentation is to annotate public declarations with triple-slash doc comments following mo-doc conventions. This captures mo:core standards to render meaningful documentation pages.

Does mo-doc support verifying doc strings for Motoko source files?▼

Yes, mo-doc supports verifying Motoko doc strings. The documentation process enforces module-level and per-declaration doc blocks following mo:core conventions and supports verification via mo-doc to ensure complete API docs.

Why are my Motoko documentation pages missing public functions?▼

Motoko documentation pages miss public functions when public declarations lack triple-slash doc comments. Adding comprehensive doc strings to all public API symbols ensures mo-doc renders meaningful documentation pages.

Can I enforce a consistent doc style across Motoko packages for CI workflows?▼

You can enforce consistent doc style across Motoko packages for CI workflows by applying module-level and per-declaration doc blocks following mo:core conventions. This supports docs generation workflows for release and CI.