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

update-documentation

Generate and update AirStack module documentation with mkdocs and Markdown.

Updated Apr 8, 2026
Search Tags:#system architecture#code documentation#mkdocs#module documentation#README generation#AirStack
One-click install
npx skills add https://github.com/cindy-woo/cindy-airstack --skill update-documentation-cindy-woo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-documentation
Source: https://github.com/cindy-woo/cindy-airstack/tree/main/.agents/skills/update-documentation
Command: npx skills add https://github.com/cindy-woo/cindy-airstack --skill update-documentation-cindy-woo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, mkdocs, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the documentation process for new and updated modules in the AirStack framework, ensuring consistency and discoverability.

Core Features & Use Cases

  • Automated Documentation Creation: Facilitates the creation of comprehensive README files for new modules.
  • mkdocs Navigation Update: Dynamically updates the mkdocs navigation to include new modules.
  • Layer Overview Documentation: Adds brief mentions of the module in the appropriate layer overview pages.
  • System-Level Documentation: Generates system-level documentation for complex features or integrations.
  • Architecture Diagrams: Updates system architecture diagrams to reflect new module connections.
  • Building and Verification: Provides commands to build and verify the documentation.
  • Testing Documentation Links: Ensures all documentation links are working correctly.
  • API Documentation: Offers optional API documentation for complex C++ packages.
  • Breaking Changes Documentation: Documents any breaking changes for future reference.
  • Integration Checklist: Updates the integration checklist if new patterns are introduced.
  • Documentation Standards: Adheres to AirStack's documentation standards and conventions.

Quick Start

Run the update-documentation skill to generate documentation for a new module in AirStack.

Frequently Asked Questions about update-documentation

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

FAQPage Schema
How do I automate README generation and module documentation for AirStack?▼

Automating README generation for AirStack is achieved by running the update-documentation Skill, which creates comprehensive module documentation and updates mkdocs navigation automatically.

What is the best way to update mkdocs navigation and system architecture diagrams for new modules?▼

Updating mkdocs navigation and system architecture diagrams is handled by automating documentation updates, which dynamically integrates new AirStack modules into the existing layer overviews and architecture visualizations.

Do I need Python and mkdocs to generate and build AirStack documentation?▼

Yes, you need Python and mkdocs installed to generate Markdown formatting, build the documentation site, and verify that all documentation links are working correctly.

Can I document breaking changes and API references for complex C++ packages in AirStack?▼

Yes, you can document breaking changes for future reference and generate optional API documentation specifically tailored for complex C++ packages within the AirStack framework.

How do I test documentation links and verify the build for AirStack modules?▼

Testing documentation links and verifying the build is provided through specific commands that ensure all references are working correctly and the documentation adheres to AirStack standards.

Related Skills

Explore More Software Engineering Skills→
cindy-woocindy-woo

write-mkdocs-documentation

Create and update MkDocs documentation for the AirStack platform.

Community
Advanced
parkwoocheolparkwoocheol
91

composewebview-documentation

No, I need to provide accurate JSON for backend_api_call.incorrectly formatted input.

Community
Intermediate
jinwoonghongjinwoonghong

moai-docs-generation

Generate technical documentation from source code and Markdown using Sphinx, MkDocs, and Docusaurus.

Community
Advanced
bresillabresilla
1

stig

Generate Markdown, mdbook, JSON, or HTML docs from Doxygen-style C/C++ comments.

Community
Advanced