skills.rest
castacks
castacksOFFICIAL
Explore all skills by this author →
Website𝕏@airlabcmuGitHub

update-documentation

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

84|28|Updated Jun 7, 2024
Search Tags:#automation#architecture#documentation#mermaid#mkdocs#readme-template#airstack
One-click install
npx skills add https://github.com/castacks/AirStack --skill update-documentation-castacks
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-documentation
Source: https://github.com/castacks/AirStack/tree/main/.agents/skills/update-documentation
Command: npx skills add https://github.com/castacks/AirStack --skill update-documentation-castacks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is mandatory for new modules and features, and keeping mkdocs navigation, templates, and diagrams up to date is error-prone when done manually.

Core Features & Use Cases

  • Enforces a standardized, up-to-date documentation workflow after adding a module (README, mkdocs.yml, diagrams, and architecture docs).
  • Guides maintainers through creating module READMEs, updating system docs, and updating navigation across layers.
  • Supports consistency across layer overviews and integration guides.

Quick Start

Run the documentation update workflow after adding a new module.

Frequently Asked Questions about update-documentation

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

FAQPage Schema
How do I update mkdocs.yml navigation after adding a new module?▼

To update mkdocs.yml navigation, this workflow guides maintainers through adding new module entries and validating links. It ensures README templates, system docs, and navigation stay current.

What is the best way to keep mermaid diagrams and README templates consistent?▼

Keeping mermaid diagrams and README templates consistent requires a standardized documentation workflow. This approach applies repeatable updates to module READMEs and architecture docs after new module integration.

How do I automate AirStack documentation updates for new modules?▼

Automating AirStack documentation updates involves running a repeatable workflow after adding a module. It updates module READMEs, mkdocs.yml navigation, and mermaid diagrams while validating links and references.

Does this documentation workflow validate links and references across layer overviews?▼

Yes, this documentation workflow validates links and references across layer overviews. It ensures integration guides and system docs remain accurate when new modules are added to the project.

Can I use this to standardize README templates for module developers?▼

Yes, you can use this to standardize README templates for module developers. It enforces a standardized, up-to-date documentation workflow that guides maintainers through creating consistent module READMEs.

Related Skills

Explore More Content & Communication Skills→
castackscastacks
84

add-ros2-package

Create a ROS 2 package scaffold with CMakeLists.txt, package.xml, config, and launch templates.

Official
Intermediate
yoanbernabeuyoanbernabeu
34

slidev-deployment

Deploy Slidev presentations to GitHub Pages, Netlify, Vercel, or Docker.

Community
Advanced
jason660519jason660519

code-wiki

Generate a codebase wiki with Mermaid architecture diagrams for any repository.

Community
Advanced
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic