mcpField
D
doc-sync

doc-sync

github.com/chmouelTesting & quality31343 installsUpdated today
Repository

About doc-sync

doc-sync is a documentation consistency-check skill for lazyworktree. It compares keybindings and help content across the README, man page and in-app help, then reports discrepancies with file paths and line numbers.

Key features

  1. 01Compares three documentation sources
  2. 02Finds missing keybindings
  3. 03Checks description inconsistencies
  4. 04Flags outdated information and spelling
  5. 05Reports paths and line numbers

Use cases

  1. 01Checking keybinding consistency before a release
  2. 02Finding mismatches between help text and documentation

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/chmouel/lazyworktree --skill doc-sync

After installing, type/doc-syncin Claude Code to confirm it loaded.

Details

From the project README

Documentation Sync Check

Compare documentation sources for consistency across keybindings and feature documentation.

Instructions

  1. Read README keybindings section: Use the Read tool to read README.md, then locate the ## Key section (keybindings table)

  2. Read man page keybindings: Use the Read tool to read lazyworktree.1, then locate the KEYBINDINGS section

  3. Read help screen text: Use the Read tool to read internal/app/screen/help.go, then locate the helpText variable containing the in-app help content

Analysis Required

Compare these three sources and identify:

  1. Missing keybindings in any source
  2. Inconsistent descriptions between sources
  3. Outdated or incorrect information
  4. British spelling violations
  5. Specific recommendations to bring all sources into sync

Report findings with file paths and line numbers for any discrepancies found.

Comments

Markdown supported