Shortcut Audit

What it does

This skill, Shortcut Audit, analyzes shortcut definitions within code and compares them against existing documentation to identify discrepancies. It examines both a primary documentation file (website/guide/shortcuts.md) and an optional local document (dev-docs/shortcuts.md). The skill then reports missing documentation entries, references to removed shortcuts, and potential conflicts or collisions at the operating system level, proposing updates and necessary tests if changes are needed.

When to use it

• When ensuring shortcut definitions in code are accurately reflected in project documentation.
• To identify outdated documentation referencing shortcuts that have been removed from the codebase.
• During development to proactively prevent conflicts or collisions between OS-level shortcuts.
• As part of a regular maintenance process for VMark projects, adhering to existing conventions unless explicitly asked to redesign.

Key capabilities

• Reads and compares shortcut definitions from code against documentation files.
• Identifies missing documentation entries related to shortcuts.
• Detects references to removed shortcuts in documentation.
• Reports OS-level conflicts or collisions between shortcuts.
• Proposes updates to both code and documentation, along with required tests.

Example prompts

• "Run a shortcut audit against the current codebase."
• "Compare the shortcuts defined in website/guide/shortcuts.md with the code."
• "Check for any missing or outdated shortcut documentation entries."

Tips & gotchas

• The skill requires access to both the codebase and the relevant documentation files (website/guide/shortcuts.md and potentially dev-docs/shortcuts.md).
• It's important to confirm bindings in both WYSIWYG and Source modes separately for a comprehensive audit.
• The skill prefers existing VMark conventions when suggesting updates, so significant redesigns may require specific instructions.