Skip to content

Commit 8bc2e69

Browse files
authored
Restructure getting started docs (#8044)
1 parent 031b9fc commit 8bc2e69

File tree

161 files changed

+1439
-1248
lines changed

Some content is hidden

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

161 files changed

+1439
-1248
lines changed

docs/azure/gettingstarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In the Command Palette, type `Azure` to list the commands that are specific to A
3131

3232
**Review settings.** To edit or review your current settings in VS Code, use (`kb(workbench.action.openSettings)`), to open the Settings editor. It is helpful to review settings that any of the extensions may contribute.
3333

34-
**Identify and customize keyboard shortcuts.** You can use the Keyboard Shortcuts editor (`kb(workbench.action.openGlobalKeybindings)`) to find and configure keyboard shortcuts in VS Code. Get more info about [Keyboard Shortcuts editor](/docs/getstarted/keybindings.md#keyboard-shortcuts-editor).
34+
**Identify and customize keyboard shortcuts.** You can use the Keyboard Shortcuts editor (`kb(workbench.action.openGlobalKeybindings)`) to find and configure keyboard shortcuts in VS Code. Get more info about [Keyboard Shortcuts editor](/docs/editor/keybindings.md#keyboard-shortcuts-editor).
3535

3636
**Redisplay notifications.** You can right-click the bell icon in the bottom right of the Status Bar in VS Code to see missed notifications.
3737

docs/copilot/copilot-customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Copilot can help you generate code, for example as part of a refactoring, genera
3535
3636
### Use settings
3737

38-
You can configure custom code-generation instructions by using the `setting(github.copilot.chat.codeGeneration.instructions)` setting. You can define custom instructions at the User or Workspace level, and you can also specify language-specific instructions. Get more information about [language-specific settings](/docs/getstarted/settings.md#language-specific-editor-settings).
38+
You can configure custom code-generation instructions by using the `setting(github.copilot.chat.codeGeneration.instructions)` setting. You can define custom instructions at the User or Workspace level, and you can also specify language-specific instructions. Get more information about [language-specific settings](/docs/editor/settings.md#language-specific-editor-settings).
3939

4040
The following code snippet shows how to define a set of instructions in the `settings.json` file. To define instruction directly in settings, configure the `text` property. To reference an external file, configure the `file` property.
4141

docs/copilot/copilot-settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ MetaSocialImage: images/shared/github-copilot-social.png
1010
---
1111
# GitHub Copilot in VS Code settings reference
1212

13-
This article lists the configuration settings for GitHub Copilot in Visual Studio Code. For general information about working with settings in VS Code, refer to [User and workspace settings](/docs/getstarted/settings.md), as well as the [Variables reference](/docs/editor/variables-reference.md) for information about predefined variable support.
13+
This article lists the configuration settings for GitHub Copilot in Visual Studio Code. For general information about working with settings in VS Code, refer to [User and workspace settings](/docs/editor/settings.md), as well as the [Variables reference](/docs/editor/variables-reference.md) for information about predefined variable support.
1414

1515
> [!TIP]
1616
> If you don't yet have a Copilot subscription, you can use Copilot for free by signing up for the [Copilot Free plan](https://github.com/github-copilot/signup) and get a monthly limit of completions and chat interactions.
1717
18-
The team is continuously working on improving Copilot in VS Code and adding new features. Some features are still experimental. Try them out and share your feedback in [our issues](https://github.com/microsoft/vscode-copilot-release/issues). Get more info about the [feature lifecycle in VS Code](/docs/getstarted/settings.md#feature-lifecycle).
18+
The team is continuously working on improving Copilot in VS Code and adding new features. Some features are still experimental. Try them out and share your feedback in [our issues](https://github.com/microsoft/vscode-copilot-release/issues). Get more info about the [feature lifecycle in VS Code](/docs/editor/settings.md#feature-lifecycle).
1919

2020
## General settings
2121

docs/cpp/colorization-cpp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The Visual Studio Code C/C++ extension now supports semantic colorization, when
1717

1818
## Themes
1919

20-
Colors can be associated using the existing support for theming and color customization in VS Code. See the [VS Code Themes documentation](/docs/getstarted/themes.md) for more information.
20+
Colors can be associated using the existing support for theming and color customization in VS Code. See the [VS Code Themes documentation](/docs/editor/themes.md) for more information.
2121

2222
Colors are associated with [semantic tokens](https://code.visualstudio.com/api/extension-guides/color-theme#semantic-colors) as well as [TextMate scopes](https://macromates.com/manual/en/language_grammars#naming_conventions).
2323

docs/cpp/cpp-ide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ When you type a member access symbol (`.` or `->`), the editor displays a list o
3737

3838
The C/C++ extension for Visual Studio Code supports source code formatting using [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and vc_format. Both of these formatting options are included in the extension, with clang-format being the default.
3939

40-
You can format an entire file with **Format Document** (`kb(editor.action.formatDocument)`) or just the current selection with **Format Selection** (`kb(editor.action.formatSelection)`) in right-click context menu. You can also trigger formatting based on user gestures such as typing, saving, and pasting with the following [settings](/docs/getstarted/settings.md):
40+
You can format an entire file with **Format Document** (`kb(editor.action.formatDocument)`) or just the current selection with **Format Selection** (`kb(editor.action.formatSelection)`) in right-click context menu. You can also trigger formatting based on user gestures such as typing, saving, and pasting with the following [settings](/docs/editor/settings.md):
4141

4242
* `editor.formatOnSave` - to format when you save your file.
4343
* `editor.formatOnType` - to format as you type (triggered on the `kbstyle(;)` character).
@@ -46,7 +46,7 @@ To learn more about formatting, see [Formatting](/docs/editor/codebasics.md#form
4646

4747
### Clang-format
4848

49-
By default, the clang-format style is set to `file`. This means that if a `.clang-format` file is found in your workspace, the settings specified in the file are used as the formatting reference. Otherwise formatting is based on the default style specified in the `C_Cpp.clang_format_fallbackStyle` [setting](/docs/getstarted/settings.md).
49+
By default, the clang-format style is set to `file`. This means that if a `.clang-format` file is found in your workspace, the settings specified in the file are used as the formatting reference. Otherwise formatting is based on the default style specified in the `C_Cpp.clang_format_fallbackStyle` [setting](/docs/editor/settings.md).
5050

5151
Currently, the default formatting style is `Visual Studio`, an approximation of the default code formatter in Visual Studio. It implies the following settings:
5252

@@ -59,7 +59,7 @@ IndentCaseLabels: false
5959
ColumnLimit: 0
6060
```
6161

62-
To use a different version of clang-format than the one that ships with the extension, change the `C_Cpp.clang_format_path` [setting](/docs/getstarted/settings.md) to the path where the clang-format binary is installed.
62+
To use a different version of clang-format than the one that ships with the extension, change the `C_Cpp.clang_format_path` [setting](/docs/editor/settings.md) to the path where the clang-format binary is installed.
6363

6464
For example, on the Windows platform, use:
6565

@@ -69,7 +69,7 @@ For example, on the Windows platform, use:
6969

7070
### vc_format
7171

72-
By default, if an `.editorconfig` file with relevant settings is identified near the code being formatted, the Visual C++ formatting engine is used instead of clang-format. Otherwise, navigate to the `C_Cpp.formatting` [setting](/docs/getstarted/settings.md) and set it to `vc_format` to use the Visual C++ formatting engine.
72+
By default, if an `.editorconfig` file with relevant settings is identified near the code being formatted, the Visual C++ formatting engine is used instead of clang-format. Otherwise, navigate to the `C_Cpp.formatting` [setting](/docs/editor/settings.md) and set it to `vc_format` to use the Visual C++ formatting engine.
7373

7474
### Enhanced semantic colorization
7575

docs/csharp/cs-dev-kit-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ This project has adopted the code of conduct defined by the [Contributor Covenan
7575

7676
Note that, depending on your network speed, installing the .NET Core runtime might take some time. By default, the installation terminates unsuccessfully if it takes longer than 4.5 minutes to finish. If you believe this is too little (or too much) time to allow for the download, you can change the timeout value by setting `dotnetAcquisitionExtension.installTimeoutValue` to a custom value.
7777

78-
[Learn more about configuring VS Code settings](/docs/getstarted/settings.md) and see below for an example of a custom timeout in a `settings.json` file. In this example, the custom timeout value is 180 seconds, or 3 minutes:
78+
[Learn more about configuring VS Code settings](/docs/editor/settings.md) and see below for an example of a custom timeout in a `settings.json` file. In this example, the custom timeout value is 180 seconds, or 3 minutes:
7979

8080
```json
8181
{

docs/csharp/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ You can attach to a C# process using with the Command Palette `kb(workbench.acti
9393

9494
## Configuration options
9595

96-
There are many options and settings available to configure the debugger. You can use `launchSettings.json`, VS Code [User Settings](/docs/getstarted/settings) to modify your debug options, or directly modify your `launch.json`.
96+
There are many options and settings available to configure the debugger. You can use `launchSettings.json`, VS Code [User Settings](/docs/editor/settings) to modify your debug options, or directly modify your `launch.json`.
9797

9898
### launchSettings.json
9999

docs/datascience/data-wrangler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,4 +205,4 @@ If you have problems, have feature requests, or any other feedback, please submi
205205

206206
## Data and telemetry
207207

208-
The Microsoft Data Wrangler extension for Visual Studio Code collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](https://go.microsoft.com/fwlink/?LinkId=521839) to learn more. This extension respects the `telemetry.telemetryLevel` setting which you can learn more about at https://code.visualstudio.com/docs/getstarted/telemetry.
208+
The Microsoft Data Wrangler extension for Visual Studio Code collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](https://go.microsoft.com/fwlink/?LinkId=521839) to learn more. This extension respects the `telemetry.telemetryLevel` setting which you can learn more about at https://code.visualstudio.com/docs/editor/telemetry.

docs/devcontainers/containers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ The Features sourced in VS Code UI now come from a central index, which you can
324324

325325
### "Always installed" Features
326326

327-
Similar to how you can [set extensions to always be installed](#always-installed-extensions) in your dev container, you can use the `setting(dev.containers.defaultFeatures)` User [setting](/docs/getstarted/settings.md) to set Features you'd always like installed:
327+
Similar to how you can [set extensions to always be installed](#always-installed-extensions) in your dev container, you can use the `setting(dev.containers.defaultFeatures)` User [setting](/docs/editor/settings.md) to set Features you'd always like installed:
328328

329329
```json
330330
"dev.containers.defaultFeatures": {
@@ -446,7 +446,7 @@ If a base image or Feature configures an extension that you do not want installe
446446

447447
### "Always installed" extensions
448448

449-
If there are extensions that you would like always installed in any container, you can update the `setting(dev.containers.defaultExtensions)` User [setting](/docs/getstarted/settings.md). For example, if you wanted to install the [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens) and [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extensions, you would specify their extension IDs as follows:
449+
If there are extensions that you would like always installed in any container, you can update the `setting(dev.containers.defaultExtensions)` User [setting](/docs/editor/settings.md). For example, if you wanted to install the [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens) and [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extensions, you would specify their extension IDs as follows:
450450

451451
```json
452452
"dev.containers.defaultExtensions": [

docs/devcontainers/create-dev-container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ If you already have VS Code and Docker installed, you can click the badge above
459459

460460
In some cases, you may want to create a configuration for a repository that you do not control or that you would prefer didn't have a configuration included in the repository itself. To handle this situation, you can configure a location on your local filesystem to store configuration files that will be picked up automatically based on the repository.
461461

462-
First, update the **Dev > Containers: Repository Configuration Paths** [User setting](/docs/getstarted/settings.md) with the local folder you want to use to store your repository container configuration files.
462+
First, update the **Dev > Containers: Repository Configuration Paths** [User setting](/docs/editor/settings.md) with the local folder you want to use to store your repository container configuration files.
463463

464464
In the Settings editor, you can search for 'dev containers repo' to find the setting:
465465

0 commit comments

Comments
 (0)