Skip to content

docs: add Marketplace README for VS Code extension package#100

Merged
ktmage merged 3 commits intomasterfrom
development
Mar 8, 2026
Merged

docs: add Marketplace README for VS Code extension package#100
ktmage merged 3 commits intomasterfrom
development

Conversation

@ktmage
Copy link
Copy Markdown
Owner

@ktmage ktmage commented Mar 8, 2026

Summary / 概要

Adds a dedicated README.md inside packages/platforms/vscode/ so that the VS Code Marketplace store page displays the extension description correctly.

VS Code Marketplace のストアページに拡張機能の説明が正しく表示されるよう、packages/platforms/vscode/ に専用の README.md を追加します。

Background / 背景

After the monorepo migration, README.md remained only at the repository root. Since vsce package packages the README.md from the extension directory (where package.json lives), the .vsix file no longer included a README, causing the Marketplace page to show no description.

モノレポ移行後、README.md はリポジトリルートにしか存在しませんでした。vsce package は拡張機能ディレクトリの README.md をパッケージに含めるため、.vsix に README が含まれず、Marketplace ページの説明が空になっていました。

Changes / 変更内容

  • New file: packages/platforms/vscode/README.md
    • User-facing content extracted from the root README (features, requirements, installation, demo)
    • Development-specific sections (build, project structure) excluded
    • Links to CONTRIBUTING.md and LICENSE use absolute GitHub URLs (relative paths do not work on Marketplace)
    • English and Japanese bilingual sections maintained

Testing / テスト

  • Verified the file is not excluded by .vscodeignore
  • Content renders correctly as Markdown

@ktmage ktmage merged commit 2f222f7 into master Mar 8, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant