sync-docs

Scan recent git commits to update documentation for changed actions and workflows.

5|9|Updated Dec 20, 2024
One-click install
npx skills add https://github.com/Netcracker/qubership-workflow-hub --skill sync-docs-netcracker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/Netcracker/qubership-workflow-hub/tree/main/.claude/skills/sync-docs
Command: npx skills add https://github.com/Netcracker/qubership-workflow-hub --skill sync-docs-netcracker

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps repository documentation up to date by scanning recent commits and updating documentation for all changed actions and reusable workflows.

Core Features & Use Cases

  • Automatic documentation refresh: detects changes in actions and reusable workflows and updates their docs.
  • Target-aware updates: refreshes only the touched targets and synchronizes the catalog.
  • Use Case: after a commit touches multiple actions, run this skill to propagate changes across docs and keep the catalog current.

Quick Start

Run the sync-docs skill to scan the last N commits and refresh documentation for all touched targets.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I auto-sync documentation after recent git commits?

To automate documentation updates, scan recent git commits to identify changed actions and reusable workflows, then refresh only the touched targets and synchronize the catalog.

What is the best way to keep repository documentation up to date with code changes?

The best way to keep repository documentation current is to scan recent git commits and automatically propagate changes across all affected action and workflow documentation sections.

How does automated documentation sync read workflow targets?

Automated documentation sync reads SKILL.md-based targets in the repository to determine which workflow and action documentation sections need to be generated or updated after recent commits.

Can I update only the documentation for actions modified in recent commits?

Yes, target-aware updates detect changes in actions and reusable workflows and refresh only the touched targets, ensuring documentation updates are scoped to recently modified code.

Do I need git history access to synchronize documentation and catalogs?

Yes, synchronizing documentation and catalogs requires access to git history to scan the last N commits and identify which actions and reusable workflows have been changed.

When should I not use automated documentation synchronization?

You should avoid automated documentation synchronization when your repository does not use SKILL.md-based targets or when you lack the required git history access needed to scan recent commits.