Skip to content

docs: consolidate VS Code and GitHub Copilot plugin docs - #2889

Open
marcel-rbro wants to merge 8 commits into
masterfrom
docs/vscode-copilot-consolidation
Open

docs: consolidate VS Code and GitHub Copilot plugin docs#2889
marcel-rbro wants to merge 8 commits into
masterfrom
docs/vscode-copilot-consolidation

Conversation

@marcel-rbro

Copy link
Copy Markdown
Contributor

Combines #2871 (VS Code) and #2874 (GitHub Copilot CLI and desktop app) into one change. All three clients run the same Apify plugin, so they need to ship together and cross-link to each other - merging either PR alone leaves the docs either duplicated or with a coverage hole.

Commits from both original PRs are preserved; the final commit wires the VS Code page into the GitHub Copilot hub.

Supersedes #2871 and #2874.

daveomri and others added 5 commits August 18, 2026 18:07
The VS Code marketplace install and the Copilot CLI/desktop app pages
document the same plugin, so present all three as one family:

- Copilot hub lists VS Code as a third surface and links to it
- VS Code page points at the hub and both sibling clients instead of
  the deleted install-from-source flow
- CLI and desktop app pages cross-link back to VS Code
- By provider entry names all three clients
@marcel-rbro marcel-rbro added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels Aug 18, 2026
@marcel-rbro marcel-rbro self-assigned this Aug 18, 2026
@apify-service-account

apify-service-account commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

✅ Preview for this PR (commit 3a859113) is ready at https://pr-2889.preview.docs.apify.com (see action run).

Both existing provider hubs use the "What you can build" heading, so
match it. Also name VS Code in the GitHub Copilot card on the
integrations landing page, since the hub it links to now covers it.
- Drop the stale preview-feature caveat from the VS Code page; VS Code's
  agent plugins docs no longer mark the feature as preview, and the CLI
  and desktop app pages already omit it
- Add Authentication paths to the VS Code and desktop app pages so the
  CLI and SDK skills document their token setup, matching the CLI page
- Restore both default marketplaces in the chat.plugins.marketplaces
  snippet; the previous one silently dropped github/copilot-plugins
- Use <kbd> for keyboard shortcuts, matching mcp.md and console.md
- Format the apify plugin and agent names as code in headings
- Split the desktop app install step to match its numbered callouts
- Explain on the CLI page why it needs the marketplace added manually
- Switch the settings snippet to json5, the repo's convention for
  JSON with comments
Per review feedback: VS Code is its own platform, not something under
GitHub Copilot. Drop it from the by-provider line and the Copilot card
on the integrations landing page, and reword the hub intro so VS Code
reads as a separate platform that runs the same plugin. The VS Code card
stays on the hub as a cross-reference.
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. t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants