About shortcut-audit
A skill for auditing keyboard shortcut documentation against the bindings found in code. It reports missing or outdated entries and OS-level conflicts, with separate checks for WYSIWYG and Source modes.
Key features
- 01Read shortcut documentation
- 02Locate shortcut definitions in code
- 03Map bindings to documentation
- 04Report missing and removed shortcuts
- 05Check OS conflicts and mode bindings
Use cases
- 01Find shortcuts missing from documentation
- 02Identify docs for removed bindings
- 03Review operating-system shortcut collisions
- 04Compare WYSIWYG and Source mode bindings
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ xiaolai/ vmark --skill shortcut-auditAfter installing, type/shortcut-auditin Claude Code to confirm it loaded.
Bundled filesreferences/paths.md
Details
From the project READMEShortcut Audit
Overview
Compare shortcut definitions in code against documentation and report gaps or conflicts.
Workflow
- Read docs:
website/guide/shortcuts.md(primary, in repo)dev-docs/shortcuts.md(if present — not always created)
- Scan code for shortcut sources (see
references/paths.md). - Extract current shortcuts from code and map them to doc entries.
- Report:
- Missing doc entries
- Docs that reference removed shortcuts
- OS-level conflicts or collisions
- Propose updates and required tests if changes are requested.
Notes
- Confirm WYSIWYG and Source mode bindings separately.
- Prefer existing conventions in VMark unless told to redesign.
Comments
Markdown supported