Does it perform any validation?

Yes, it uses the 'just lint' command to verify that any changes made to the documentation or scripts do not introduce syntax or formatting errors.

What parts of the documentation are checked?

It focuses on Quick Start sections, Command Line Options tables, and the help functions within the scripts themselves.

Which installation scripts does this skill support?

It is designed to support both Bash scripts (install.sh) and PowerShell scripts (install.ps1), ensuring cross-platform documentation parity.

How does it handle different languages?

The skill specifically checks for consistency between the primary README.md (English) and the docs/README.ja.md (Japanese) to ensure both versions are updated simultaneously.

Sync Install Docs

Name: Sync Install Docs
Author: tqer39

bytqer39

•

Aprendizaje y Documentación

Synchronizes installation scripts with their corresponding documentation and help text to ensure consistency across languages and platforms.

This skill automates the maintenance of project documentation by ensuring that changes to installation scripts (install.sh and install.ps1) are accurately reflected in README.md and Japanese documentation files. It specifically monitors command-line options, help functions, and quick start guides to prevent documentation rot. By verifying synchronization between Bash and PowerShell scripts and their bilingual documentation counterparts, it ensures that users always have access to up-to-date installation instructions and CLI help text.

Características Principales

01Help text validation for show_help() and Show-Help functions

02Bilingual documentation support for English and Japanese locales

03Automatic synchronization of CLI options between scripts and README files

04Integrated verification using just lint to ensure documentation quality

05Cross-platform consistency checks for Bash and PowerShell installation scripts

061 GitHub stars

Casos de Uso

01Updating dotfiles installation scripts with new command-line flags or arguments

02Refactoring installation help text to match actual script behavior

03Maintaining parity between English and Japanese documentation during script updates

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tqer39/dotfiles sync-install-docs

For use in Claude.ai and ChatGPT

Download Skill