القائمة
Verify documentation matches code implementation. Compare documentation with code to check keyboard shortcuts, config options, and module descriptions for consistency.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
Run clippy with auto-fix and report issues. Automatically fix issues that clippy knows how to fix safely, then report remaining warnings that need manual attention.
Run all pre-commit checks before committing. Run all quality checks including format check, clippy, tests, and verify no secrets or TODOs are staged.
Step-by-step checklist for adding a new agent type to Panoptes. Follow the checklist to add the enum variant, create the adapter implementation, and update the factory method.
Step-by-step checklist for adding a new input mode to Panoptes. Follow the checklist to add the enum variant, create the handler in the appropriate module, and update the dispatcher.
Generate test scaffolding for untested modules. Analyze public functions, identify test cases, and create comprehensive test coverage.
Step-by-step checklist for adding a new view to Panoptes. Follow the checklist to create the view enum variant, render function, input handler, and update all dispatch points.
استنادا إلى تصنيف SOC المهني
| name | doc-sync |
| description | Verify documentation matches code implementation. Compare documentation with code to check keyboard shortcuts, config options, and module descriptions for consistency. |
Verify that documentation matches the actual code implementation.
Files to compare:
README.md - Quick reference sectiondocs/KEYBOARD_REFERENCE.md - Complete referencesrc/input/normal/*.rs - Actual implementationsVerification:
KeyCode::Char('x') patterns in input handlersCommon issues:
'a' for adding projects, but code uses 'n'Files to compare:
docs/CONFIG_GUIDE.md - Config documentationsrc/config.rs - Config struct and defaultsVerification:
Config structFiles to compare:
CLAUDE.md - Module responsibilities sectionsrc/*/mod.rs - Module doc commentsVerification:
//! commentsFiles to compare:
CLAUDE.md - Key Types sectionVerification:
Documentation Sync Report:
README.md vs KEYBOARD_REFERENCE.md:
[MISMATCH] README: 'a' = Add project
REFERENCE: 'n' = Add project
[OK] All other shortcuts match
CONFIG_GUIDE.md vs config.rs:
[OK] All 12 config options documented
[OK] Default values match
CLAUDE.md vs codebase:
[MISSING] hooks/mod.rs HookEventType not documented in Key Types
[OK] Module responsibilities up to date
Run these to spot-check documentation:
# Find all KeyCode patterns in input handlers
grep -r "KeyCode::Char" src/input/ | grep -v test
# List config fields
grep "pub " src/config.rs | head -20
# Check module doc comments
head -5 src/*/mod.rs
After running this skill, fix discrepancies by: