docstrings

What problem does it solve?

Julia package maintainers often struggle with incomplete, inconsistent, or outdated API documentation that causes Documenter.jl checkdocs failures, missing public symbol docs, and stale docs/src/API pages, requiring hours of manual, error-prone work to fix.

Core Features & Use Cases

• Convention-matching docstring generation: Detects existing package docstring styles (e.g. DocStringExtensions macros) to write new or normalized docstrings that match the established pattern.
• Old-format docstring normalization: Converts legacy indented struct/function docstrings to modern DocStringExtensions conventions, including handling named constructors and multiple dispatch overloads.
• API page synchronization: Updates docs/src/API pages to ensure every exported, documented symbol appears exactly once, with stale entries and phantom exports removed.
• Use Case: A Julia package maintainer whose CI is failing due to missing docstrings or checkdocs warnings can use this skill to automatically write consistent docstrings for all public symbols and update the API index pages to pass the docs build.

Quick Start

Invoke the docstrings skill to add missing docstrings to all exported symbols in your Julia package and sync the API documentation pages.