| name | sync-herdr-docs |
| description | dot_config/herdr/ 配下（config.toml のキーバインド・[[keys.command]]・scripts/・plugins/）を追加・変更・削除したら、必ずこのスキルを使って docs/herdr.md のショートカットチートシートを追従更新する。herdr のキーバインド変更、hunk-diff / lazygit-tab などのスクリプト変更、プラグインアクションの追加のほか、「チートシート更新して」「docs/herdr.md 直して」という依頼でも使う。 |
sync-herdr-docs
dot_config/herdr/ の変更を docs/herdr.md（herdr ショートカットチートシート）へ反映するための手順。チートシートは実設定と一致していてこそ価値があるため、herdr 設定を変更したコミットには対応するドキュメント更新を含める。
対応関係
docs/herdr.md の各セクションは設定ファイルの特定箇所に対応している。変更した箇所に対応するセクションだけを更新すればよい。
| 設定側の変更 | docs/herdr.md の更新箇所 |
|---|
[keys] の prefix | 冒頭の prefix 説明 |
[keys] のアクションバインド上書き（コメント解除・値変更・"" での無効化） | 「Herdr 本体のショートカット」該当表。無効化・置き換えは独自セクション側にも注記 |
[[keys.command]] の追加・変更・削除 | 「独自ショートカット」セクションの該当表 |
scripts/*.sh の挙動変更（トグル・戻り先・ラベルなど） | 該当キーの「動作」説明文 |
plugins/ の追加・削除 | 対応するキーがあれば独自セクション、なければ更新不要 |
[experimental] の入力関連（switch_ascii_input_source_in_prefix など） | 冒頭の注記 |
手順
dot_config/herdr/config.toml の変更差分を確認する（git diff または編集内容）。キーバインドに関係ない変更（テーマ、UI、toast など）ならチートシート更新は不要。- 変更がキーバインド・スクリプト・プラグインに関わる場合、
docs/herdr.md を読み、上の対応表に沿って該当セクションを編集する。
- キー表記は既存に合わせる:
prefix+shift+g のように backtick 囲み。prefix+X は「ctrl+f を押してから X」の意味（prefix を変更したら冒頭説明も更新）。
- スクリプト起動のバインドは、キーと動作だけでなくスクリプトの挙動（トグル、タブラベル固定、戻り先復帰など）も一文で書く。挙動はスクリプト冒頭のコメントと実装から読み取る。
- herdr デフォルト値は config.toml のコメント行が一次情報。デフォルトを上書きしたら「Herdr 本体のショートカット」表から独自セクションへ移す（またはその逆）。
- 表の並び・見出し構成は既存の docs/herdr.md を維持する。新しい機能グループが増えたときだけ小見出しを追加する。
- 更新後、config.toml の全
[[keys.command]] と有効な [keys] バインドがチートシートに漏れなく載っているか突き合わせて確認する。
注意
docs/ は .chezmoiignore 対象で chezmoi の管理外。chezmoi apply には影響しない。- チートシートの言語は日本語。キー名・アクション名・スクリプト名は原文のまま。
- 設定変更なしでドキュメントだけ直す依頼（表記ゆれ、誤記）でもこの構成ルールに従う。
