doc sync

Other Community

Skill notes

Documentation Locations

The Which Key Lazy project has documentation in these locations: README.md - Main project README (uses long name "Which Key LazyVim-style") CLAUDE.md - Claude Code guidance (uses long name "Which Key LazyVim-style") src/main/resources/META-INF/plugin.xml - Plugin manifest with description

Code Locations

Key source files that documentation references: src/main/kotlin/lazyideavim/whichkeylazy/ - All source code gradle.properties - Plugin metadata (name, version, build targets) settings.gradle.kts - Project name Config file: ~/.whichkey-lazy.json

Core Mindset

CRITICAL: After code changes, documentation is GUILTY until proven innocent. ❌ WRONG APPROACH: "Be conservative, only update if clearly wrong" ✅ RIGHT APPROACH: "Be aggressive finding issues, conservative making fixes" Trust Hierarchy: Working implementation in codebase (highest truth)

Phase 0: Pre-Analysis Search (DO THIS FIRST)

Before reading full files, run these quick searches to find red flags:

Mode A: Documentation → Code Verification

Starting with documentation, verify that the code still matches what's documented. Steps: FIRST: Check current codebase state (Phase 0) Read the specified documentation file(s) Extract ALL code references, feature claims, and architecture descriptions

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Other
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@brandonkramer · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
No explicit requirements detected
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

01
Phase 0: Pre-Analysis Search (DO THIS FIRST)

Before reading full files, run these quick searches to find red flags:

02
Step 0: Establish Ground Truth (CRITICAL - DO FIRST)

Check package structure: `find src/main/kotlin -name "*.kt"` Check git history: `git log --oneline -10` Check key files: `gradle.properties`, `plugin.xml`, `WhichKeyConfig.kt`

03
Step 1: Understand the Task

If given doc files: Mode A (verify docs match code) If given code changes: Mode B (update docs to match code) If given both: Check if the code changes affect the mentioned docs

04
Step 2: Quick Pattern Search

Run grep searches from Phase 0 to find obvious red flags Compare package names, class names, config references

05
Step 3: Detailed Verification

Read documentation thoroughly For EACH claim or code reference: verify against actual codebase Run through the appropriate checklist above

06
Step 4: Analyze Discrepancies

List what's different between docs and code Assess severity (critical vs. minor) Determine if update is needed

07
Step 5: Make Updates if Needed

Edit documentation files with precise changes Explain what was changed and why

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.