write-docs

Writes and extends the ResoniteIO MkDocs Material documentation site with mkdocstrings API pages.

3|Updated Jun 7, 2026

Search Tags:#documentation #technical writing #api reference #github pages #mkdocs #mkdocstrings #mike

One-click install

npx skills add https://github.com/MLShukai/ResoniteIO --skill write-docs-mlshukai

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/MLShukai/ResoniteIO/tree/main/.agents/skills/write-docs
Command: npx skills add https://github.com/MLShukai/ResoniteIO --skill write-docs-mlshukai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Maintaining the ResoniteIO documentation site requires knowing where docs live, how to preview and build them, and which conventions to follow when adding API pages or new modalities. This Skill encodes those rules so documentation stays consistent and the strict build gate passes. ## Core Features & Use Cases - Docs site structure guidance: Explains the layout of `mkdocs.yml`, `docs/`, and how mkdocstrings generates Python API reference pages from docstrings. - Preview and build workflow: Covers `just docs-serve` for live-reload preview and `just docs-build` as the strict local CI gate, plus mike-based versioned deployment to GitHub Pages. - Modality documentation procedure: Provides the checklist for documenting a new modality, including creating `docs/api/<modality>.md`, updating `mkdocs.yml` nav, and extending the modalities table. - Use Case: After adding a new ResoniteIO modality, use this Skill to create its API reference page, register it in the navigation, and verify the strict MkDocs build passes. ## Quick Start Use the write-docs skill to add an API reference page for the new modality and update the MkDocs navigation.

Frequently Asked Questions about write-docs

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

FAQPage Schema

Why is the docs directory excluded from mdformat?▼

mdformat assumes plain GitHub-flavored Markdown and de-indents MkDocs Material syntax like admonitions and nested code fences, breaking rendering. Docs Markdown is validated by the strict docs-build instead, and admonition indentation is maintained manually.