Skip to content

docs: fill VS Code Marketplace listing and surface install paths#83

Merged
arnaudlh merged 4 commits into
mainfrom
docs/vscode-marketplace-listing
May 12, 2026
Merged

docs: fill VS Code Marketplace listing and surface install paths#83
arnaudlh merged 4 commits into
mainfrom
docs/vscode-marketplace-listing

Conversation

@arnaudlh
Copy link
Copy Markdown
Member

Summary

The published VS Code Marketplace listing for Git-ApeTeam.git-ape had an empty Overview tab because the VSIX never contained a README. This PR fills the listing and surfaces the new install path across the project docs.

What changed

Fill the Marketplace listing

  • extension/README.md (new) — rendered as the Marketplace Overview tab and as the VS Code Extension details panel. Includes:
    • Project intro and warning callout.
    • One-click install badges (Marketplace, vscode:extension/..., vscode-insiders:extension/...).
    • Two install options: (A) one-click from the listing, (B) chat.plugins.marketplaces setting for users who also want `ape-context` or latest-from-GitHub updates.
    • Tables enumerating the 8 agents and 13 skills that ship in the VSIX.
    • Architecture diagram, docs links, contributing/security/license section.
  • extension/CHANGELOG.md (new) — stub pointing to GitHub Releases and the docs site changelog.
  • No build-workflow changes needed: `extension/.vscodeignore` already passes `README.md` and `CHANGELOG.md` through to the VSIX (verified with `vsce ls`).

Surface the Marketplace install path

  • README.md — header now lists both the docs site and the Marketplace listing. Install section gains a new Option A: VS Code Marketplace (one-click) with shields.io badges; previous options renumber to B/C/D.
  • website/docs/getting-started/installation.md — comparison table led by the new Marketplace option. New `## Option A: VS Code Marketplace (one-click)` section mirrors the README. Existing slugs (`#vscode-plugin`, `#cli-plugin`, `#local-dev`) preserved for backward compatibility.
  • website/docs/intro.md — adds Marketplace install badges to Quick Start.
  • website/docs/getting-started/vscode-vs-cli.md — "Marketplace install" parity row now links directly to the listing; workspace-recommendation section clarifies the auto-install path is the agent-plugin route and points to the Marketplace as a fallback when `chat.plugins.enabled` is disabled.
  • website/docs/getting-started/onboarding.md — agent-plugin requirement info box now distinguishes the two install paths.

Correct prerequisite framing

The Marketplace VSIX installs as a regular VS Code extension, so it does not require `chat.plugins.enabled`. Only the agent-plugin install paths (`chat.plugins.marketplaces`, Chat: Install Plugin From Source, `copilot plugin install`) are gated by that org-level setting. All docs updated to reflect this.

Verification

  • `vsce ls` (run from `extension/`) confirms `README.md` and `CHANGELOG.md` are in the VSIX payload.
  • Docusaurus production build is clean: `DOCUSAURUS_BASE_URL=/ npm run --prefix website build` ➜ `[SUCCESS] Generated static files in "build".` Only the pre-existing `vscode-languageserver-types` webpack warning remains.
  • `get_errors` reports no markdown/MDX errors on any of the changed files.

Diff stats

```
README.md | 21 +++++++++++++++------
extension/CHANGELOG.md | (new)
extension/README.md | (new)
website/docs/getting-started/installation.md | 24 ++++++++++++++++++-----
website/docs/getting-started/onboarding.md | 2 +-
website/docs/getting-started/vscode-vs-cli.md | 6 ++++--
website/docs/intro.md | 11 ++++++++++-
```

Out of scope

  • No build/workflow changes.
  • No agent or skill content changes (only the README enumeration of them).
  • No source-code changes to the plugin manifest beyond what the published v0.0.2 already contains.

Follow-ups (separate PRs)

  • The Marketplace Features tab still shows empty Name/Description columns for `chatAgents`/`chatSkills`. The contribution-point schema only accepts `path` and `when` — VS Code reads name/description from the agent/SKILL frontmatter at install time. Filling those Marketplace columns is a Marketplace-side rendering limitation, not a packaging fix.

The published Marketplace listing for Git-ApeTeam.git-ape had an empty Overview tab because the VSIX never contained a README. Adds extension/README.md (rendered as the Marketplace Overview) and extension/CHANGELOG.md so the listing shows the value proposition, install paths, and links instead of being blank.

Also surfaces the Marketplace install path across the docs:

- README.md: header now lists both the docs site and the Marketplace listing; install section gains a new "Option A: VS Code Marketplace (one-click)" with shields.io badges linking to the listing, vscode:extension URI, and vscode-insiders:extension URI. Renumbers existing options to B/C/D.

- website/docs/getting-started/installation.md: comparison table led by the new Marketplace option; new Option A section mirrors the README; existing slugs (#vscode-plugin, #cli-plugin, #local-dev) preserved for backward compatibility.

- website/docs/intro.md: adds Marketplace badges to Quick Start.

- website/docs/getting-started/vscode-vs-cli.md: "Marketplace install" parity row now links to the listing; workspace-recommendation section clarifies the auto-install path is the agent-plugin route and points to the Marketplace as a fallback when chat.plugins.enabled is disabled.

- website/docs/getting-started/onboarding.md: agent-plugin requirement info box now distinguishes the two install paths.

Clarifies that the VS Code Marketplace install path does NOT require chat.plugins.enabled — only the agent-plugin paths (chat.plugins.marketplaces setting, Chat: Install Plugin From Source, copilot plugin install) are gated by that org-level setting.
@arnaudlh arnaudlh self-assigned this May 12, 2026
@arnaudlh arnaudlh added the documentation Improvements or additions to documentation label May 12, 2026
arnaudlh added 2 commits May 12, 2026 10:39
…arkdownlint

Fixes MD032/MD022 violations flagged by CI on extension/README.md lines 67-68.
GitHub's README sanitizer strips links using non-HTTP(S) protocols, so

the vscode:extension/* and vscode-insiders:extension/* badge URLs only

rendered as static images. Route the badges through HTTPS redirect

pages (install.html, install-insiders.html) hosted on GitHub Pages —

mirroring the existing open-settings.html pattern — so the badges are

clickable on GitHub and still trigger the editor's protocol handler.
Copy link
Copy Markdown
Contributor

@suuus suuus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was pressured to accept this one.

@arnaudlh arnaudlh merged commit 239a845 into main May 12, 2026
5 checks passed
@arnaudlh arnaudlh deleted the docs/vscode-marketplace-listing branch May 12, 2026 12:27
@arnaudlh arnaudlh added this to the v0.0.3 milestone May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants