update-docs

Edit Mermaid diagrams and regenerate PNGs to synchronize streaming architecture documentation.

1|Updated Apr 10, 2026

Search Tags:#documentation #markdown #mermaid #diagrams #content-management

Ready to run

npx skills add https://github.com/ngareleo/xstream --skill update-docs-ngareleo

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/ngareleo/xstream/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/ngareleo/xstream --skill update-docs-ngareleo

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines updating technical documentation to reflect code changes, maintaining consistency across diagrams, prose, and naming conventions.

Core Features & Use Cases

Diagram Synchronization: Edit Mermaid .mmd files and regenerate corresponding PNG screenshots with precise scenario references.
Documentation Consistency: Ensure markdown prose in docs/architecture/Streaming/01-Playback-Scenarios.md aligns with visual diagrams for clarity.
Use Case: When modifying streaming architecture, automatically update both visual diagrams and scenario descriptions for accurate technical communication.

Quick Start

Edit a scenario diagram in the Mermaid source, regenerate its PNG, and update the related markdown section to keep documentation consistent.

Frequently Asked Questions about update-docs

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

FAQPage Schema

How do I keep Mermaid diagrams synchronized with markdown documentation during updates?▼

Synchronizing Mermaid diagrams with markdown documentation requires manually editing the `.mmd` files, regenerating the corresponding PNG screenshots, and updating the related markdown prose to ensure visual and textual content remain consistent.

What is the best way to update streaming architecture diagrams and scenario descriptions?▼

Updating streaming architecture diagrams involves editing the Mermaid source files for the specific playback scenario, regenerating the PNG visual, and modifying the markdown prose in the architecture documentation directory to maintain accurate technical communication across both visual and textual formats.

Does updating technical documentation with this approach require manual editing?▼

Yes, updating technical documentation with this approach requires manual editing of Mermaid `.mmd` files and markdown prose, along with manual diagram regeneration to ensure precise scenario references and naming convention consistency across the architecture documentation.

When do I need to regenerate PNG screenshots from Mermaid files?▼

You need to regenerate PNG screenshots from Mermaid files when modifying the streaming architecture scenarios, ensuring that the visual diagrams accurately reflect the updated code changes and align with the corresponding markdown documentation for clear technical communication.

Are there limitations to keeping documentation consistent across diagrams and prose?▼

Limitations include the reliance on manual editing for both Mermaid `.mmd` files and markdown prose, meaning any architecture modifications require explicit, separate updates to both the visual diagrams and textual scenario descriptions to maintain full consistency.