vscode-extension-documentation

Creates README.md files for VS Code extensions with marketplace-ready sections and formatting.

4|Updated Jan 22, 2026
One-click install
npx skills add https://github.com/cc01cc/cmtx-project --skill vscode-extension-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vscode-extension-documentation
Source: https://github.com/cc01cc/cmtx-project/tree/main/.kilo/skills-repo/cmtx/vscode-extension-documentation
Command: npx skills add https://github.com/cc01cc/cmtx-project --skill vscode-extension-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill streamlines creating professional, marketplace-ready README files for VS Code extensions, ensuring consistency with marketplace guidelines and best practices.

Core Features & Use Cases

  • Structured README generation: Create README sections with title, value proposition, installation, prerequisites, Quick Start, configuration, FAQ, license, and contribution guidance.
  • Media guidance: Require at least one screenshot or GIF with alt text to improve marketplace presentation.
  • Marketplace readiness checks: Include commands, permissions disclosure, telemetry, compatibility notes, and cross-skill handoff references.
  • Cross-skill handoff: Swap drafts with standard documentation guidelines when collaborating with other teams.

Quick Start

Run the vscode-extension-documentation skill to generate a marketplace-ready README.md for your extension.

Frequently Asked Questions about vscode-extension-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a marketplace-ready README for a VS Code extension?

Generate a marketplace-ready README for a VS Code extension by structuring Markdown with installation, prerequisites, Quick Start, configuration, FAQ, license, and contribution sections to ensure consistency with marketplace guidelines and best practices.

What sections should a VS Code extension README include for marketplace publishing?

A VS Code extension README should include a title, value proposition, installation, prerequisites, Quick Start, configuration, FAQ, license, and contribution guidance. It must also disclose commands, permissions, telemetry, and compatibility notes.

How do I add screenshots and GIFs to a VS Code extension README with proper alt text?

Add screenshots and GIFs to a VS Code extension README with descriptive alt text to improve marketplace presentation and accessibility. The documentation generation process requires at least one media element with alt text.

What is the best way to structure markdown documentation for VS Code extensions?

Structure markdown documentation for VS Code extensions using scannable sections like installation and Quick Start. This approach applies marketplace readiness checks, ensuring commands, permissions, and compatibility notes are clearly disclosed.

Can I swap VS Code extension documentation drafts with standard guidelines when collaborating?

Yes, you can swap VS Code extension documentation drafts with standard documentation guidelines using cross-skill handoff references. This allows seamless collaboration with other teams while maintaining marketplace readiness.