Skip to content

Commit 94291df

Browse files
github-actions[bot]claude-yolo[bot]
authored andcommitted
docs: Claude Code docs polish — VS Code requirement lowered, MCP/troubleshoot clarifications (minor)
Co-Authored-By: claude-yolo[bot] <claude-yolo@lroole.com>
1 parent cbdea3a commit 94291df

83 files changed

Lines changed: 374 additions & 353 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/.metadata.json

Lines changed: 147 additions & 147 deletions
Large diffs are not rendered by default.

content/en/docs/claude-code/artifacts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Owners on Team and Enterprise plans control artifacts from [claude.ai admin sett
226226

227227
### Enable or disable artifacts
228228

229-
To enable or disable artifacts for the whole organization, go to **Settings > Claude Code > Capabilities** and use the **Artifacts** toggle. On Enterprise plans with role-based access control, you can additionally scope artifacts to specific roles: go to **Settings > Roles**, edit a role, and set the **Artifacts** permission under the **Claude Code** group.
229+
To enable or disable artifacts for the whole organization, go to [**Settings > Claude Code > Capabilities**](https://claude.ai/admin-settings/claude-code) and use the **Artifacts** toggle. On Enterprise plans with role-based access control, you can additionally scope artifacts to specific roles: go to [**Settings > Roles**](https://claude.ai/admin-settings/roles), edit a role, and set the **Artifacts** permission under the **Claude Code** group.
230230

231231
### Control connector calls from artifacts
232232

@@ -238,7 +238,7 @@ Public sharing is off by default on Team and Enterprise plans, so members can sh
238238

239239
### Set a retention policy
240240

241-
To set how long artifacts are kept before automatic deletion, go to **Settings > Data & privacy controls**. You can set separate retention periods for artifacts that are still private to their author and artifacts that have been shared.
241+
To set how long artifacts are kept before automatic deletion, go to [**Settings > Data & privacy controls**](https://claude.ai/admin-settings/data-privacy-controls). You can set separate retention periods for artifacts that are still private to their author and artifacts that have been shared.
242242

243243
### Review the audit log
244244

content/en/docs/claude-code/claude-apps-gateway-deploy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,8 @@ For questions and feedback, use [Claude Code support](https://support.claude.com
234234
* **Login issue**: the developer runs `claude --debug-file ./claude-debug.txt`, reproduces, and sends that file plus the gateway's audit log for the same window
235235
* **Inference issue**: the model requested, the upstreams configured, and the gateway's audit log for the request, which records which upstream served it and the response status
236236

237+
The gateway's stderr includes the audit event stream, the audit log records developer identities, and the debug file records hook and MCP server output from the developer's machine. Review and redact these before posting to a public issue.
238+
237239
| Symptom | Cause | Fix |
238240
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
239241
| A developer's `/login` shows the standard account picker instead of the **Cloud gateway** screen | `forceLoginMethod` or `forceLoginGatewayUrl` isn't set in managed settings on that machine | Deploy the [managed settings file](/en/claude-apps-gateway#set-the-gateway-url) to the device; `/login` reads the gateway URL from there |

content/en/docs/claude-code/claude-code-on-the-web.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,7 @@ For Max and Pro accounts, the two visibility options are **Private** and **Publi
760760

761761
Check your session for sensitive content before sharing. Sessions may contain code and credentials from private GitHub repositories. Repository access verification is not enabled by default.
762762

763-
To require recipients to have repository access, or to hide your name from shared sessions, go to Settings > Claude Code > Sharing settings.
763+
To require recipients to have repository access, or to hide your name from shared sessions, go to [**Settings > Claude Code > Sharing settings**](https://claude.ai/settings/claude-code).
764764

765765
### Archive sessions
766766

content/en/docs/claude-code/mcp.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,8 @@ claude mcp add --transport http github https://api.githubcopilot.com/mcp/ \
491491
--header "Authorization: Bearer YOUR_GITHUB_PAT"
492492
```
493493

494+
Replace `YOUR_GITHUB_PAT` with your personal access token. The `claude mcp add` command saves the configuration without validating credentials, so a placeholder value is accepted here but the server fails to connect later. To verify the connection, run `/mcp` and check that the server shows `connected`. A server with bad credentials shows `failed`.
495+
494496
Then work with GitHub:
495497

496498
```text theme={null}

content/en/docs/claude-code/overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ Claude Code runs on several surfaces: the terminal, IDE extensions, a desktop ap
2222
<Tab title="Native Install (Recommended)">
2323
**macOS, Linux, WSL:**
2424

25-
```bash theme={null}
25+
```bash theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
2626
curl -fsSL https://claude.ai/install.sh | bash
2727
```
2828

2929
**Windows PowerShell:**
3030

31-
```powershell theme={null}
31+
```powershell theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
3232
irm https://claude.ai/install.ps1 | iex
3333
```
3434

3535
**Windows CMD:**
3636

37-
```batch theme={null}
37+
```batch theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
3838
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd
3939
```
4040

@@ -50,7 +50,7 @@ Claude Code runs on several surfaces: the terminal, IDE extensions, a desktop ap
5050
</Tab>
5151

5252
<Tab title="Homebrew">
53-
```bash theme={null}
53+
```bash theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
5454
brew install --cask claude-code
5555
```
5656

@@ -62,7 +62,7 @@ Claude Code runs on several surfaces: the terminal, IDE extensions, a desktop ap
6262
</Tab>
6363

6464
<Tab title="WinGet">
65-
```powershell theme={null}
65+
```powershell theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
6666
winget install Anthropic.ClaudeCode
6767
```
6868

@@ -74,7 +74,7 @@ Claude Code runs on several surfaces: the terminal, IDE extensions, a desktop ap
7474

7575
You can also install with [apt, dnf, or apk](/en/setup#install-with-linux-package-managers) on Debian, Fedora, RHEL, and Alpine.
7676

77-
Then start Claude Code in any project:
77+
Then start Claude Code in any project. Replace `your-project` with the path to a project directory on your machine:
7878

7979
```bash theme={null}
8080
cd your-project
@@ -208,7 +208,7 @@ Here are some of the ways you can use Claude Code:
208208
* Step away from your desk and keep working from your phone or any browser with [Remote Control](/en/remote-control)
209209
* Message [Dispatch](/en/desktop#sessions-from-dispatch) a task from your phone and open the Desktop session it creates
210210
* Kick off a long-running task on the [web](/en/claude-code-on-the-web) or the [Claude mobile app](/en/mobile), then pull it into your terminal with `claude --teleport`. Teleport requires a claude.ai subscription.
211-
* Hand off a terminal session to the [Desktop app](/en/desktop) with `/desktop` for visual diff review
211+
* Run `/desktop` to continue your current terminal session in the [Desktop app](/en/desktop), where you can review diffs visually. Available on macOS and x64 Windows.
212212
* Route tasks from team chat: mention `@Claude` in [Slack](/en/slack) with a bug report and get a pull request back
213213
</Accordion>
214214
</AccordionGroup>

content/en/docs/claude-code/routines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ Connectors are the [claude.ai integrations](/en/mcp#use-mcp-servers-from-claude-
334334

335335
When you create a routine, all of your currently connected connectors are included by default. Remove any that aren't needed to limit which tools Claude has access to during the run. You can also add connectors directly from the routine form.
336336

337-
To manage or add connectors outside of the routine form, visit **Settings > Connectors** on claude.ai or use `/schedule update` in the CLI.
337+
To manage or add connectors outside of the routine form, visit [claude.ai/customize/connectors](https://claude.ai/customize/connectors) or use `/schedule update` in the CLI.
338338

339339
### Environments and network access
340340

@@ -372,7 +372,7 @@ See [Network access](/en/claude-code-on-the-web#network-access) for details on a
372372

373373
Routines draw down subscription usage the same way interactive sessions do. In addition to the standard subscription limits, routines have a daily cap on how many runs can start per account. See your current consumption and remaining daily routine runs at [claude.ai/code/routines](https://claude.ai/code/routines) or [claude.ai/settings/usage](https://claude.ai/settings/usage).
374374

375-
When a routine hits the daily cap or your subscription usage limit, organizations with usage credits turned on can keep running routines on metered overage. Without usage credits, additional runs are rejected until the window resets. Turn on usage credits from **Settings > Billing** on claude.ai.
375+
When a routine hits the daily cap or your subscription usage limit, organizations with usage credits turned on can keep running routines on metered overage. Without usage credits, additional runs are rejected until the window resets. Turn on usage credits at [claude.ai/settings/usage](https://claude.ai/settings/usage). On Team and Enterprise plans, an admin turns them on for the organization at [claude.ai/admin-settings/usage](https://claude.ai/admin-settings/usage).
376376

377377
One-off runs do not count against the daily routine cap. They draw down your regular subscription usage like any other session, but they are exempt from the per-account daily routine run allowance.
378378

content/en/docs/claude-code/troubleshoot-install.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,12 @@ curl -sI https://downloads.claude.ai/claude-code-releases/latest
5959

6060
In PowerShell, run `curl.exe -sI` instead. PowerShell aliases `curl` to `Invoke-WebRequest`, which rejects the `-sI` flags.
6161

62-
An `HTTP/2 200` line means you reached the server. If you see no output, `Could not resolve host`, or a connection timeout, your network is blocking the connection. Common causes:
62+
An `HTTP/2 200` line means you reached the server. Other results point to the cause:
63+
64+
* `403`: usually a proxy or network filter blocking the host, or Claude Code is [not available in your region](https://www.anthropic.com/supported-countries)
65+
* `5xx`: usually a temporary service issue; wait a few minutes and retry
66+
67+
If you see no output, `Could not resolve host`, or a connection timeout, your network is blocking the connection. Common causes:
6368

6469
* Corporate firewalls or proxies blocking `downloads.claude.ai`
6570
* Regional network restrictions: try a VPN or alternative network
@@ -361,10 +366,16 @@ The `curl ... | bash` command downloads the script and pipes it to Bash for exec
361366
**Solutions:**
362367

363368
1. **Check network stability**: Claude Code binaries are hosted at `downloads.claude.ai`. Test that you can reach it:
369+
364370
```bash theme={null}
365371
curl -sI https://downloads.claude.ai/claude-code-releases/latest
366372
```
367-
An `HTTP/2 200` line means you reached the server and the original failure was likely intermittent; retry the install command. If you see `Could not resolve host` or a connection timeout, your network is blocking the download.
373+
374+
An `HTTP/2 200` line means you reached the server and the original failure was likely intermittent; retry the install command. Other results point to the cause:
375+
376+
* `403`: usually a proxy or network filter blocking the host, or Claude Code is [not available in your region](https://www.anthropic.com/supported-countries)
377+
* `5xx`: usually a temporary service issue; wait a few minutes and retry
378+
* `Could not resolve host` or a connection timeout: your network is blocking the download
368379

369380
2. **Try an alternative install method**:
370381

@@ -436,10 +447,16 @@ The installer couldn't reach the download server. This typically means `download
436447
**Solutions:**
437448

438449
1. **Test connectivity directly**:
450+
439451
```bash theme={null}
440452
curl -sI https://downloads.claude.ai/claude-code-releases/latest
441453
```
442454

455+
An `HTTP/2 200` line means the server is reachable. Other results point to the cause:
456+
457+
* `403`: usually a proxy or network filter blocking the host, or Claude Code is [not available in your region](https://www.anthropic.com/supported-countries)
458+
* `5xx`: usually a temporary service issue; wait a few minutes and retry
459+
443460
2. **If behind a proxy**, set `HTTPS_PROXY` so the installer can route through it. See [proxy configuration](/en/network-config#proxy-configuration) for details.
444461
```bash theme={null}
445462
export HTTPS_PROXY=http://proxy.example.com:8080

content/en/docs/claude-code/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Claude Code is designed to work with most development environments, but may cons
3737

3838
If memory usage stays high after these steps, run `/heapdump` to write a JavaScript heap snapshot and a memory breakdown to `~/Desktop`. On Linux without a Desktop folder, the files are written to your home directory.
3939

40-
The breakdown shows resident set size, JS heap, array buffers, and unaccounted native memory, which helps identify whether the growth is in JavaScript objects or in native code. To inspect retainers, open the `.heapsnapshot` file in Chrome DevTools under Memory → Load.
40+
The breakdown shows resident set size, JS heap, array buffers, and unaccounted native memory, which helps identify whether the growth is in JavaScript objects or in native code. To inspect retainers, open the `.heapsnapshot` file in Chrome DevTools under Memory → Load; the breakdown is the file ending in `-diagnostics.json`.
4141

4242
<Warning>
4343
The `.heapsnapshot` file contains every string in the process. Don't attach it to a public issue or share it. Attach only the `-diagnostics.json` file when reporting a memory issue on [GitHub](https://github.com/anthropics/claude-code/issues). That file contains memory statistics and no conversation content or credentials.

content/en/docs/claude-code/vs-code.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ With the extension, you can review and edit Claude's plans before accepting them
1616

1717
Before installing, make sure you have:
1818

19-
* VS Code 1.98.0 or higher
19+
* VS Code 1.94.0 or higher
2020
* An Anthropic account: any paid Claude subscription (Pro, Max, Team, or Enterprise) or a Claude Console account works, and no API key is required. You'll [sign in](/en/authentication#log-in-to-claude-code) with this account when you first open the extension. If you access Claude through a third-party provider like Amazon Bedrock or Google Cloud's Agent Platform, see [Use third-party providers](#use-third-party-providers) for setup instructions.
2121

2222
<Tip>
@@ -391,6 +391,8 @@ claude mcp add --transport http github https://api.githubcopilot.com/mcp/ \
391391
--header "Authorization: Bearer YOUR_GITHUB_PAT"
392392
```
393393

394+
Replace `YOUR_GITHUB_PAT` with your personal access token. The `claude mcp add` command saves the configuration without validating credentials, so a placeholder value is accepted here but the server fails to connect later. To verify the connection, type `/mcp` in the chat panel and check that the server shows `connected`. A server with bad credentials shows `failed`.
395+
394396
Once configured, ask Claude to use the tools (e.g., "Review PR #456").
395397

396398
To manage MCP servers without leaving VS Code, type `/mcp` in the chat panel. The MCP management dialog lets you enable or disable servers, reconnect to a server, and manage OAuth authentication. See the [MCP documentation](/en/mcp) for available servers.
@@ -482,7 +484,7 @@ The server is named `ide` and is hidden from `/mcp` because there's nothing to c
482484

483485
### Extension won't install
484486

485-
* Ensure you have a compatible version of VS Code (1.98.0 or later)
487+
* Ensure you have a compatible version of VS Code (1.94.0 or later)
486488
* Check that VS Code has permission to install extensions
487489
* Try installing directly from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=anthropic.claude-code)
488490

@@ -491,7 +493,7 @@ The server is named `ide` and is hidden from `/mcp` because there's nothing to c
491493
The Spark icon appears in the **Editor Toolbar** (top-right of editor) when you have a file open. If you don't see it:
492494

493495
1. **Open a file**: The icon requires a file to be open. Having just a folder open isn't enough.
494-
2. **Check VS Code version**: Requires 1.98.0 or higher (Help → About)
496+
2. **Check VS Code version**: Requires 1.94.0 or higher (Help → About)
495497
3. **Restart VS Code**: Run "Developer: Reload Window" from the Command Palette
496498
4. **Disable conflicting extensions**: Temporarily disable other AI extensions (Cline, Continue, etc.)
497499
5. **Check workspace trust**: The extension doesn't work in Restricted Mode

0 commit comments

Comments
 (0)