Skills doc-sync
๐Ÿ“ฆ

doc-sync

Content revision r2 Safe โš™๏ธ External commands

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.

Supports: Claude Codex Code(CC)
๐Ÿฅ‰ 78 Bronze

Install with my Agent

Copy this request to your Agent. It includes the canonical Skill page and manifest.

Agent request
Review the Skillstore skill "doc-sync" from https://skillstore.io/skills/jetbrains-doc-sync.md and its manifest at https://skillstore.io/api/skills/jetbrains-doc-sync/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Your Agent should still show its plan and request any confirmation required by the security policy.

Agent-readable resources

Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.

Test it

Using "doc-sync". Check whether the mapping guide matches the current API.

Expected outcome:

  • Files checked: mapping guide, API definition, and one working implementation.
  • Discrepancy: one named parameter no longer exists in the current signature.
  • Update: corrected the example and preserved the surrounding explanation.

Using "doc-sync". Determine whether a recent class change requires documentation updates.

Expected outcome:

  • Git history and related documentation were reviewed.
  • No public API or documented behavior changed.
  • No documentation update was needed.

Using "doc-sync". Audit documentation after a removed mapping function.

Expected outcome:

  • Affected references were found in two documentation files.
  • Obsolete examples were replaced with the supported usage pattern.
  • One migration detail was marked for human review.

Security Audit

Safe
v9 โ€ข 7/23/2026 Open versioned report

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.

1
Files scanned
276
Lines analyzed
0
Review items
0
False positives ignored
No confirmed security findings were detected by the latest completed static and semantic audit. This does not prove the skill has no side effects.
Audited by: codex View Audit History โ†’
Share & cite this report

Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.

Open versioned report
Security Assessment

Copy report link

https://skillstore.io/skills/jetbrains-doc-sync/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/jetbrains-doc-sync/security.svg)](https://skillstore.io/skills/jetbrains-doc-sync?utm_source=security_passport_badge)

HTML badge

<a href="https://skillstore.io/skills/jetbrains-doc-sync?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/jetbrains-doc-sync/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Embed card

<iframe src="https://skillstore.io/embed/skills/jetbrains-doc-sync.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>
Academic citations (APA ยท BibTeX ยท CFF)

APA citation

JetBrains. (2026). doc-sync security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/jetbrains-doc-sync/audits/9

BibTeX citation

@techreport{jetbrains-jetbrains-doc-sync-2026, author = {JetBrains}, title = {doc-sync security audit report (audit version 9)}, institution = {Skillstore}, year = {2026}, number = {9}, url = {https://skillstore.io/skills/jetbrains-doc-sync/audits/9}, note = {Author version unspecified} }

CITATION.cff

cff-version: 1.2.0 message: "If you use this Skill, cite its author and this versioned security audit report." title: "doc-sync security audit report (audit version 9)" version: "unspecified" type: report authors: - name: "JetBrains" date-released: "2026-07-23" url: "https://skillstore.io/skills/jetbrains-doc-sync/audits/9" identifiers: - type: other value: "skillstore:jetbrains-doc-sync:audit:9" description: "Skillstore immutable audit report identifier"

Skillstore Score

Why this score Evidence Confidence: High
55
Architecture
85
Maintainability
87
Content
70
Community
83
Spec Compliance

What You Can Build

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.

Try These Prompts

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.

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.

Avoid

  • 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.

Frequently Asked Questions

Can this skill update documentation from code changes?
Yes. It traces changed APIs and behavior to related IdeaVim documentation, then updates confirmed discrepancies.
Can it verify code from documentation?
Yes. It checks documented signatures, parameters, and usage patterns against current APIs and working implementations.
Which documentation files does it cover?
It targets the doc directory, README.md, CONTRIBUTING.md, and other relevant IdeaVim documentation found during analysis.
Does it change documentation automatically?
It can make precise updates when evidence confirms an error. Ambiguous cases are reported for human review.
Why does it inspect Git history?
Git history reveals removals, deprecations, and earlier changes that explain why documentation may be outdated.
Does it run or test documented examples?
It primarily compares examples with source APIs and working implementations. Runtime execution depends on the available project tools and task scope.

Developer Details

Author

JetBrains

License

MIT

Skillstore revision

r2

Version notice

The author did not declare a version.

Ref

ebdfe608f5de2b66ff37ab4af12af8ac4f5e8006

Maintenance freshness

7/25/2026

Usage

5 downloads ยท 225 views

File structure

๐Ÿ“„ SKILL.md

More from JetBrains

View all
View all