skills.rest
cindy-woo
cindy-wooCOMMUNITY
Explore all skills by this author →
GitHub

write-mkdocs-documentation

Create and update MkDocs documentation for the AirStack platform.

Updated Apr 8, 2026
Search Tags:#documentation#markdown#technical writing#mkdocs#airstack
One-click install
npx skills add https://github.com/cindy-woo/cindy-airstack --skill write-mkdocs-documentation-cindy-woo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-mkdocs-documentation
Source: https://github.com/cindy-woo/cindy-airstack/tree/main/.agents/skills/write-mkdocs-documentation
Command: npx skills add https://github.com/cindy-woo/cindy-airstack --skill write-mkdocs-documentation-cindy-woo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill unit offers comprehensive guidelines and templates for creating high-quality MkDocs documentation for AirStack, solving the problem of inefficient documentation practices and lack of standardization.

Core Features & Use Cases

  • Structured Documentation Guidelines: Offers step-by-step guidelines for writing, organizing, and structuring MkDocs documentation.
  • Visual Elements and Formatting Standards: Instructs on effective use of visual aids, tables, code blocks, and formatting for clarity and accessibility.
  • Navigation Organization: Helps organize navigation structure in mkdocs.yml for seamless user experience.
  • Writing Style Guidelines: Provides general and specific writing guidelines for technical documentation.

Quick Start

Follow the guide to create new MkDocs documentation or update existing ones by structuring your content, following the writing style, and using the recommended templates.

Frequently Asked Questions about write-mkdocs-documentation

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

FAQPage Schema
How do I structure technical documentation in MkDocs for the AirStack platform?▼

To structure MkDocs documentation for AirStack, organize content hierarchically, configure navigation in mkdocs.yml, and apply standardized writing guidelines to ensure clarity and seamless user accessibility.

What is the best way to use Mermaid diagrams in MkDocs documentation?▼

The best way to use Mermaid diagrams in MkDocs is to embed them within Markdown files as visual aids, following formatting standards that enhance technical clarity and structural accessibility for readers.

How do I organize navigation in mkdocs.yml for a seamless user experience?▼

Organize navigation in mkdocs.yml by structuring your Markdown documents logically, grouping related technical pages, and applying consistent formatting to guide users through the AirStack documentation seamlessly.

Do I need basic familiarity with AirStack to write technical documentation for it?▼

Yes, you need basic familiarity with the AirStack platform and MkDocs to effectively create and update technical documentation, as the guidelines focus on platform-specific standards, Markdown, and structured writing.

What writing style guidelines should I follow for technical documentation?▼

Follow general and specific technical writing guidelines that emphasize clarity, use of visual elements like tables and code blocks, and standardized formatting to maintain consistency across all MkDocs documentation.

Can I use templates to update existing MkDocs documentation?▼

Yes, you can use provided templates to update existing MkDocs documentation by restructuring content, aligning with recommended writing styles, and applying standardized visual elements and formatting rules.

Related Skills

Explore More Software Engineering Skills→
guardiatechnologyguardiatechnology

kata-docs-serve

Serve local Markdown documentation with a hot-reloading MkDocs server.

Official
Intermediate
castackscastacks
84

update-documentation

Update README templates, mkdocs.yml navigation, and mermaid diagrams after adding a module.

Official
Intermediate
fuzzy-dynamicsfuzzy-dynamics
1

markdown-mermaid-writing

Generate and validate Markdown documents with Mermaid diagrams using templates.

Official
Advanced
soo-kate-yeonsoo-kate-yeon

moai-docs-generation

Generate API documentation from source code and OpenAPI specifications.

Community
Advanced