docs: consolidate VS Code and GitHub Copilot plugin docs by marcel-rbro · Pull Request #2889 · apify/apify-docs

marcel-rbro · 2026-08-18T16:12:50Z

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.

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

apify-service-account · 2026-08-18T16:13:26Z

✅ Preview for this PR (commit a058f773) 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.

Audit the screenshots against CONTRIBUTING.md - keep only what prose can't convey, and recolour the surviving indicators to #F86606. - Remove 10 screenshots that restated their own steps or showed commands already given in copyable code blocks; move the few details they carried into prose - Recolour the indicators on the 5 remaining images from brick red to the #F86606 required by CONTRIBUTING.md - Merge three stacked admonitions on the CLI page into one, moving the read-only and slow-connection notes into the steps they belong to - Use <kbd> for the CLI key references - Expand Visual Studio Code (VS Code) on first mention per page - Order the hub cards CLI, desktop app, VS Code - Fix the CLI authorization alt text, which described a browser window while showing a terminal

TC-MO

Good split, pages read well. One blocker: the CLI install steps assume the
Copilot CLI can't see the plugin by default, but awesome-copilot ships
registered and the plugin is in it. Please retest /plugin install apify@awesome-copilot on a clean profile.

Before merge I'd also like the triplicated skills/prompts/limitations blocks
pulled into a partial (they're already drifting), and one story on whether VS
Code is a Copilot client. Rest is inline.

TC-MO · 2026-08-25T11:12:34Z

+## Limitations
+
+- Long-running Actors may exceed the time a single tool call waits for completion. Reduce the scope or split the work across multiple prompts.
+- Each Actor run consumes Apify platform usage from your plan in addition to any VS Code usage. See [Billing](/account/billing) for details.
+- Skills that edit files in your project (Actor development, actorization, SDK integration) make local changes - review them before deploying or committing.


Are those deliberately different than the ones in cli doc LOC 145 & desktop doc LOC 131?

If yes where did the drift come from? If not why not a partial?

TC-MO · 2026-08-25T11:19:33Z

+- An `apify` routing agent that picks the right tool or skill from a natural-language request.
+- Five built-in skills for common workflows (see [Bundled skills](#bundled-skills) below).
+
+This guide covers installation from the plugin marketplace in VS Code. It's the same plugin that powers the [GitHub Copilot CLI](/integrations/github-copilot-cli) and the [GitHub Copilot desktop app](/integrations/github-copilot-desktop) - install it once per client you use.


VSC docs would say otherwise it seems 🤔

Sorry, can you expand please - I don't think I understand the issue here.
VS Code docs says the VS Code can see Agent Plugins installed by GC CLI which is true.
All of the VSC, GC Desktop and GC CLI are powered by the same source (Apify plugin listed in awesome-copilot) I don't see how docs are wrong here.

Of course! My issue was with the ending install it once per client you use to me it suggests that if I use more than one of those I should install it separately per the client, but that is not the case right? It should be installed once and each client will pick it up?

Got it, I think we should just remove the ending - availability generally depends on a lot of things (versions of VSC and GHC) and it might be tricky to figure out correct setup. Also domain is moving very fast so I would be careful here.

TC-MO · 2026-08-25T11:28:51Z

+
+Describe what you want in plain language.
+
+> Use Apify to find a good Actor for scraping Google Maps places. Show me the best option, its input requirements, pricing model, and what kind of dataset output it returns. Do not run the Actor yet.


Is blockquote the best here? They are rendered in similar style to admonitions so I am not a fan. I would use ```text for prompts. And that goes for all blockqutoes in the doc

Is there some convention we can all follow? I am fine with rewriting in once but rewriting it every 2 months seems not very productive.

Hmm those might be remnants of older style, I'll double check our standards & style-guide files if its not codified properly we will codify it and we can rewrite later.

I asked for the blockquotes usage for prompts as that was the prevalent formatting in the docs. I'd keep the blockquote now and we can discuss on sync.

Jakub-Vacek · 2026-08-31T15:09:18Z

I tried to address some of the issues as this PR is becoming stale and it is blocking other activities. @daveomri can you please look at the GitHub related issues?
And the visual things that spans multiple docs (like cursive heading, prompts) should be likely discussed with @marcel-rbro

daveomri

Applying changes as @TC-MO suggested

Jakub-Vacek · 2026-09-10T11:24:28Z

Please @marcel-rbro @TC-MO can we somehow move this forward? It is currently blocking both GitHub and VS Code plugins.

Co-authored-by: David <david.omrai@seznam.cz>

…-consolidation # Conflicts: # sources/platform/integrations/ai/index.mdx # sources/platform/integrations/index.mdx

- Replace the italic pseudo-headings above the example prompts with a Skill / Example prompt table. - Extract the duplicated Limitations bullets into a shared _agent-plugin-limitations.mdx partial and align the wording, so the VS Code, Copilot CLI, and desktop pages stop drifting apart. - Restore the /plugin install command that was dropped from the install step, and add the missing blank line before a troubleshooting heading. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GmXAuRf1CPE7WyGTr3QR1T

The ending implied the plugin has to be installed separately in each client. Removing it rather than restating the behavior, since plugin availability depends on VS Code and Copilot versions. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GmXAuRf1CPE7WyGTr3QR1T

marcel-rbro · 2026-09-10T12:16:31Z

Final check, please confirm:

@TC-MO that the blockquotes are fine for now (as they are prevalent in docs) and we'll discuss later
@Jakub-Vacek that the limitations partial is correct for all 3 pages now that is says "Copilot usage"

Jakub-Vacek · 2026-09-10T13:08:25Z

Final check, please confirm:

@TC-MO that the blockquotes are fine for now (as they are prevalent in docs) and we'll discuss later

@Jakub-Vacek that the limitations partial is correct for all 3 pages now that is says "Copilot usage"

I would phrase it as "AI usage" if we want to reuse it.

TC-MO · 2026-09-10T15:50:33Z

I don't want to block this, we will discuss blockquotes separately, fix vale failing action & conflict and it's a ✅ from me

daveomri and others added 5 commits August 18, 2026 18:07

docs: update github copilot docs to include cli and desktop app

9a569c7

docs: create ilustrations & update copilot docs

5957aa8

docs: update the copilot cli images

9ab435c

feat: vs code docs

5e7a11c

marcel-rbro added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels Aug 18, 2026

marcel-rbro self-assigned this Aug 18, 2026

marcel-rbro added 4 commits August 18, 2026 18:17

docs: align the Copilot hub with the OpenAI and Claude hubs

1133a01

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.

marcel-rbro requested a review from TC-MO August 20, 2026 10:39

This was referenced Aug 24, 2026

docs: update github copilot docs to include cli and desktop app #2874

Closed

feat: vs code docs #2871

Closed

TC-MO requested changes Aug 25, 2026

View reviewed changes

daveomri requested changes Aug 31, 2026

View reviewed changes

daveomri assigned daveomri and unassigned daveomri Sep 10, 2026

Jakub-Vacek and others added 4 commits September 10, 2026 13:38

fix: wording

53173fa

Co-authored-by: David <david.omrai@seznam.cz>

Merge remote-tracking branch 'origin/master' into docs/vscode-copilot…

52d2d7f

…-consolidation # Conflicts: # sources/platform/integrations/ai/index.mdx # sources/platform/integrations/index.mdx

marcel-rbro requested a review from TC-MO September 10, 2026 12:15

marcel-rbro requested a review from Jakub-Vacek September 10, 2026 12:16


		Describe what you want in plain language.

		> Use Apify to find a good Actor for scraping Google Maps places. Show me the best option, its input requirements, pricing model, and what kind of dataset output it returns. Do not run the Actor yet.

Uh oh!

Conversation

marcel-rbro commented Aug 18, 2026

Uh oh!

apify-service-account commented Aug 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TC-MO left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Jakub-Vacek commented Aug 31, 2026

Uh oh!

daveomri left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Jakub-Vacek commented Sep 10, 2026

Uh oh!

marcel-rbro commented Sep 10, 2026

Uh oh!

Jakub-Vacek commented Sep 10, 2026

Uh oh!

TC-MO commented Sep 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

apify-service-account commented Aug 18, 2026 •

edited

Loading

TC-MO commented Sep 10, 2026 •

edited

Loading