# Synchronize IdeaVim Documentation

Documentation often falls behind IdeaVim code changes. This skill compares documentation with current APIs, implementations, and Git history to correct verified discrepancies.

## Install

```bash
npx skillstore add jetbrains/doc-sync
```

## Metadata

- Status: approved
- Slug: jetbrains-doc-sync
- Skillstore revision: r2
- Version status: missing
- Tree hash: db135dc38c38354c1617788b033c330d8aca716168bb5ca743d3032d4992448a
- Author: JetBrains
- GitHub username: JetBrains
- License: MIT
- Repository: https://github.com/JetBrains/ideavim/tree/master/.claude/skills/doc-sync
- Ref: ebdfe608f5de2b66ff37ab4af12af8ac4f5e8006
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands
- Quality score: 78
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/jetbrains-doc-sync
- Manifest: https://skillstore.pages.dev/api/skills/jetbrains-doc-sync/manifest

## Capabilities

- Compares documented function signatures and parameters with current IdeaVim APIs.
- Checks code examples against working implementations in the repository.
- Uses Git history to identify removals, deprecations, and breaking changes.
- Finds documentation references related to changed code or APIs.
- Updates verified documentation errors while preserving existing style and context.

## Use Cases

- Validate a documentation page: Check one IdeaVim document against current APIs and working examples before review.
- Assess documentation impact: Trace a code change to affected guides, examples, signatures, and file references.
- Review release documentation: Inspect recent removals and deprecations for documentation changes before a release.

## Prompt Templates

### Check one document

```
Check doc/ideavim-mappings.md against the current code. Report verified discrepancies and update only inaccurate content.
```

### Review a code change

```
Review changes to MappingScope.kt. Find affected documentation, verify every related example, and update confirmed errors.
```

### Audit an API topic

```
Audit documentation for mapping APIs. Compare signatures, named parameters, and usage patterns with current interfaces and working implementations.
```

### Perform a release sync

```
Review recent breaking changes and removals. Audit all affected IdeaVim documentation, make precise updates, and identify unresolved evidence gaps.
```

## Limitations

- The skill is tailored to the IdeaVim repository and its documentation layout.
- It requires access to the relevant source code, documentation, and Git history.
- It does not prove runtime behavior when implementation evidence is incomplete.
- Large documentation sets may require a focused scope for thorough verification.

## Best Practices

- Provide the changed code, target documentation, or commit range when possible.
- Verify each edit against an API definition and a working implementation.
- Review proposed documentation changes before merging them.

## Anti Patterns

- Do not request broad wording improvements without an accuracy concern.
- Do not treat documentation as proof when current code provides conflicting evidence.
- Do not remove useful context only because an example requires correction.

## Security Audit

- Audited at: 2026-07-23T15:33:45.745\+00:00
- Summary: All 18 backtick findings are false positives caused by Markdown formatting or documented, read-only search and Git commands. The network-scanning finding is also false because nmap appears only as text inside a grep pattern.

## Stats

- Views: 225
- Downloads: 11
- Favorites: 0
- Popularity score: 0