update-docs

Analyze source files and sync ryOS documentation with implementation.

1.2k|183|Updated Jan 28, 2025
One-click install
npx skills add https://github.com/ryokun6/ryos --skill update-docs-ryokun6
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/ryokun6/ryos/tree/main/.cursor/skills/update-docs
Command: npx skills add https://github.com/ryokun6/ryos --skill update-docs-ryokun6

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill keeps ryOS documentation aligned with the current codebase, reducing drift between implementation and guides.

Core Features & Use Cases

  • Automated doc syncing: Launches sub-agents to compare existing docs against source code and generate updated sections.
  • Changelog generation: Updates documentation changelogs to reflect recent changes.
  • Documentation health checks: Verifies coverage of architecture, APIs, and application references across docs.

Quick Start

Run the update-docs workflow to analyze the repository and regenerate the docs. Example commands include bun run scripts/generate-docs.ts and bun run scripts/generate-changelog.ts.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I automatically sync documentation with my codebase?

Automated documentation syncing aligns your docs with the codebase by analyzing source files and updating sections to match the implementation. It launches parallel sub-agents to compare existing documentation against current code and regenerate affected sections.

What is the best way to generate a changelog from code changes?

Generating a changelog from code changes involves running a dedicated script that analyzes recent repository updates and produces a formatted log. This ensures your documentation changelog accurately reflects the latest implementation modifications.

How does documentation generation handle API references and architecture docs?

Documentation generation handles API references and architecture docs by performing health checks that verify coverage across multiple documentation sections. It analyzes source code to ensure technical references and architectural overviews remain aligned with the actual implementation.

Can I use scripts to render HTML documentation from source files?

Yes, you can use internal scripts to render HTML documentation from source files. Running the generate-docs workflow analyzes the repository and executes rendering scripts to produce updated, viewable HTML documentation output.

Do I need to run sub-agents to update app listings and workflow documentation?

Yes, updating app listings and workflow documentation requires launching parallel sub-agents. These sub-agents compare existing documentation against source code to identify drift and generate updated sections across all affected documentation areas.