Skip to content

Commit 02e6d21

Browse files
ntroghntrogh
committed
Refresh from public docs
1 parent c191abc commit 02e6d21

File tree

253 files changed

+2365
-3
lines changed

Some content is hidden

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

253 files changed

+2365
-3
lines changed

‎api/advanced-topics/extension-host.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -22,6 +23,9 @@ DateApproved: 10/29/2024
2223
=======
2324
DateApproved: 10/29/2024
2425
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
26+
=======
27+
DateApproved: 10/29/2024
28+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2529

2630
# Summarize the whole topic in less than 300 characters for SEO purpose
2731
MetaDescription: The Visual Studio Code Extension Host is responsible for managing extensions and ensuring the stability and performance of Visual Studio Code.

‎api/advanced-topics/remote-extensions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ ContentId: 5c708951-e566-42db-9d97-e9715d95cdd1
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -21,6 +22,9 @@ DateApproved: 10/29/2024
2122
=======
2223
DateApproved: 10/29/2024
2324
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
25+
=======
26+
DateApproved: 10/29/2024
27+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2428

2529
# Summarize the whole topic in less than 300 characters for SEO purpose
2630
MetaDescription: A guide to adding Visual Studio Code Remote Development and GitHub Codespaces support to extensions

‎api/advanced-topics/tslint-eslint-migration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ ContentId: f00c4913-58e3-4a61-aa42-e769c3430906
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -21,6 +22,9 @@ DateApproved: 10/29/2024
2122
=======
2223
DateApproved: 10/29/2024
2324
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
25+
=======
26+
DateApproved: 10/29/2024
27+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2428

2529
# Summarize the whole topic in less than 300 characters for SEO purpose
2630
MetaDescription: A guide to migrating extension projects from the TSLint linter to ESLint.

‎api/advanced-topics/using-proposed-api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ContentId: f4d4e9e0-8901-405c-aaf5-faa16c32588b
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -22,6 +23,9 @@ DateApproved: 10/29/2024
2223
=======
2324
DateApproved: 10/29/2024
2425
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
26+
=======
27+
DateApproved: 10/29/2024
28+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2529

2630
# Summarize the whole topic in less than 300 characters for SEO purpose
2731
MetaDescription: Use Visual Studio Code's Proposed API

‎api/extension-capabilities/common-capabilities.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ContentId: 9c48dfbf-e49d-4f33-aadc-5ebf06d5dde0
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -22,6 +23,9 @@ DateApproved: 10/29/2024
2223
=======
2324
DateApproved: 10/29/2024
2425
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
26+
=======
27+
DateApproved: 10/29/2024
28+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2529

2630
# Summarize the whole topic in less than 300 characters for SEO purpose
2731
MetaDescription: Common capabilities that Visual Studio Code extensions (plug-ins) can take advantage of
@@ -61,6 +65,7 @@ An extension can register custom Context Menu items that will be displayed in di
6165
<<<<<<< HEAD
6266
<<<<<<< HEAD
6367
<<<<<<< HEAD
68+
<<<<<<< HEAD
6469
There are four options for storing data:
6570
=======
6671
There are five options for storing data:
@@ -77,6 +82,9 @@ There are five options for storing data:
7782
=======
7883
There are five options for storing data:
7984
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
85+
=======
86+
There are five options for storing data:
87+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
8088
8189
- [`ExtensionContext.workspaceState`](/api/references/vscode-api#ExtensionContext.workspaceState): A workspace storage where you can write key/value pairs. VS Code manages the storage and will restore it when the same workspace is opened again.
8290
- [`ExtensionContext.globalState`](/api/references/vscode-api#ExtensionContext.globalState): A global storage where you can write key/value pairs. VS Code manages the storage and will restore it for each extension activation. You can selectively synchronize key/value pairs in global storage by setting the keys for sync using `setKeysForSync` method on `globalState`.
@@ -87,6 +95,10 @@ There are five options for storing data:
8795
<<<<<<< HEAD
8896
<<<<<<< HEAD
8997
<<<<<<< HEAD
98+
<<<<<<< HEAD
99+
=======
100+
- [`ExtensionContext.secrets`](/api/references/vscode-api#ExtensionContext.secrets): A global storage for secrets (or any information that is sensitive) that will be encrypted. These are not synced across machines. For VS Code desktop, this leverages Electron's [safeStorage API](https://www.electronjs.org/docs/latest/api/safe-storage). For VS Code for the Web, this uses a Double Key Encryption (DKE) implementation.
101+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
90102
=======
91103
- [`ExtensionContext.secrets`](/api/references/vscode-api#ExtensionContext.secrets): A global storage for secrets (or any information that is sensitive) that will be encrypted. These are not synced across machines. For VS Code desktop, this leverages Electron's [safeStorage API](https://www.electronjs.org/docs/latest/api/safe-storage). For VS Code for the Web, this uses a Double Key Encryption (DKE) implementation.
92104
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

‎api/extension-capabilities/extending-workbench.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ContentId: e0d5bd37-f020-4235-ad81-c977baaeb24f
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -22,6 +23,9 @@ DateApproved: 10/29/2024
2223
=======
2324
DateApproved: 10/29/2024
2425
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
26+
=======
27+
DateApproved: 10/29/2024
28+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2529

2630
# Summarize the whole topic in less than 300 characters for SEO purpose
2731
MetaDescription: Explain how to extend Visual Studio Code's workbench area with custom UI components

‎api/extension-capabilities/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ContentId: d22675fc-6609-43f2-a66b-8f2a52597195
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -22,6 +23,9 @@ DateApproved: 10/29/2024
2223
=======
2324
DateApproved: 10/29/2024
2425
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
26+
=======
27+
DateApproved: 10/29/2024
28+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2529

2630
# Summarize the whole topic in less than 300 characters for SEO purpose
2731
MetaDescription: Learn the details of what's possible with Visual Studio Code's rich extension (plug-in) API.

‎api/extension-capabilities/theming.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ContentId: 37b6ae0a-d1b5-48b6-9bd4-9b50ef11d573
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -22,6 +23,9 @@ DateApproved: 10/29/2024
2223
=======
2324
DateApproved: 10/29/2024
2425
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
26+
=======
27+
DateApproved: 10/29/2024
28+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2529

2630
# Summarize the whole topic in less than 300 characters for SEO purpose
2731
MetaDescription: Learn how to add custom themes for colors and icons in Visual Studio Code.

‎api/extension-guides/chat-tutorial.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ContentId: bea1d4c5-71e5-4b27-ac1e-fa9b59886dab
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -22,6 +23,9 @@ DateApproved: 10/29/2024
2223
=======
2324
DateApproved: 10/29/2024
2425
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
26+
=======
27+
DateApproved: 10/29/2024
28+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2529

2630
# Summarize the whole topic in less than 300 characters for SEO purpose
2731
MetaDescription: Tutorial that walks you through creating a GitHub Copilot chat participant in VS Code by using the Chat API.
@@ -103,6 +107,7 @@ Finally, setting `isSticky: true` will automatically prepend the participant nam
103107
<<<<<<< HEAD
104108
<<<<<<< HEAD
105109
<<<<<<< HEAD
110+
<<<<<<< HEAD
106111
## Step 3: Craft the prompt and select the model
107112

108113
Now that the participant is registered, you can start implementing the logic for the code tutor. In the `extension.ts` file, you will define a prompt and select the model for the requests.
@@ -129,6 +134,11 @@ Now that the participant is registered, you can start implementing the logic for
129134
=======
130135
## Step 3: Craft the prompt
131136

137+
Now that the participant is registered, you can start implementing the logic for the code tutor. In the `extension.ts` file, you will define a prompt for the requests.
138+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
139+
=======
140+
## Step 3: Craft the prompt
141+
132142
Now that the participant is registered, you can start implementing the logic for the code tutor. In the `extension.ts` file, you will define a prompt for the requests.
133143
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
134144
@@ -152,6 +162,7 @@ const BASE_PROMPT = 'You are a helpful code tutor. Your job is to teach the user
152162
<<<<<<< HEAD
153163
<<<<<<< HEAD
154164
<<<<<<< HEAD
165+
<<<<<<< HEAD
155166
You also need to select the model for the requests. gpt-4o is recommended since it is fast and high quality.
156167

157168
```ts
@@ -184,6 +195,11 @@ Now that the prompt is selected, you need to implement the request handler. This
184195
=======
185196
## Step 4: Implement the request handler
186197

198+
Now that the prompt is selected, you need to implement the request handler. This is what will process the user's chat request. You will define the request handler, perform logic for processing the request, and return a response to the user.
199+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
200+
=======
201+
## Step 4: Implement the request handler
202+
187203
Now that the prompt is selected, you need to implement the request handler. This is what will process the user's chat request. You will define the request handler, perform logic for processing the request, and return a response to the user.
188204
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
189205
@@ -202,6 +218,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
202218
<<<<<<< HEAD
203219
<<<<<<< HEAD
204220
<<<<<<< HEAD
221+
<<<<<<< HEAD
205222
Within the body of this handler, initialize the prompt and model. Check that the model returned successfully.
206223
=======
207224
Within the body of this handler, initialize the prompt and a `messages` array with the prompt. Then, send in what the user typed in the chat box. You can access this through `request.prompt`.
@@ -226,6 +243,11 @@ Send the request using `request.model.sendRequest`, which will send the request
226243
=======
227244
Within the body of this handler, initialize the prompt and a `messages` array with the prompt. Then, send in what the user typed in the chat box. You can access this through `request.prompt`.
228245

246+
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
247+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
248+
=======
249+
Within the body of this handler, initialize the prompt and a `messages` array with the prompt. Then, send in what the user typed in the chat box. You can access this through `request.prompt`.
250+
229251
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
230252
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
231253
@@ -237,6 +259,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
237259
<<<<<<< HEAD
238260
<<<<<<< HEAD
239261
<<<<<<< HEAD
262+
<<<<<<< HEAD
240263
<<<<<<< HEAD
241264
// initialize the prompt and model
242265
let prompt = BASE_PROMPT;
@@ -290,6 +313,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
290313
=======
291314
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
292315
=======
316+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
317+
=======
293318
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
294319
// initialize the prompt
295320
let prompt = BASE_PROMPT;
@@ -312,6 +337,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
312337
<<<<<<< HEAD
313338
<<<<<<< HEAD
314339
<<<<<<< HEAD
340+
<<<<<<< HEAD
341+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
342+
=======
315343
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
316344
=======
317345
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -341,6 +369,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
341369
<<<<<<< HEAD
342370
<<<<<<< HEAD
343371
<<<<<<< HEAD
372+
<<<<<<< HEAD
344373
<<<<<<< HEAD
345374
// initialize the prompt and model
346375
let prompt = BASE_PROMPT;
@@ -372,6 +401,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
372401
=======
373402
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
374403
=======
404+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
405+
=======
375406
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
376407
// initialize the prompt
377408
let prompt = BASE_PROMPT;
@@ -394,6 +425,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
394425
<<<<<<< HEAD
395426
<<<<<<< HEAD
396427
<<<<<<< HEAD
428+
<<<<<<< HEAD
429+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
430+
=======
397431
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
398432
=======
399433
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -446,6 +480,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
446480
<<<<<<< HEAD
447481
<<<<<<< HEAD
448482
<<<<<<< HEAD
483+
<<<<<<< HEAD
449484
<<<<<<< HEAD
450485
// initialize the prompt and model
451486
let prompt = BASE_PROMPT;
@@ -492,6 +527,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
492527
=======
493528
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
494529
=======
530+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
531+
=======
495532
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
496533
// initialize the prompt
497534
let prompt = BASE_PROMPT;
@@ -529,6 +566,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
529566
<<<<<<< HEAD
530567
<<<<<<< HEAD
531568
<<<<<<< HEAD
569+
<<<<<<< HEAD
570+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
571+
=======
532572
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
533573
=======
534574
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -594,6 +634,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
594634
<<<<<<< HEAD
595635
<<<<<<< HEAD
596636
<<<<<<< HEAD
637+
<<<<<<< HEAD
597638
<<<<<<< HEAD
598639
// initialize the prompt and model
599640
=======
@@ -608,6 +649,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
608649
=======
609650
// initialize the prompt
610651
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
652+
=======
653+
// initialize the prompt
654+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
611655
=======
612656
// initialize the prompt
613657
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -621,6 +665,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
621665
<<<<<<< HEAD
622666
<<<<<<< HEAD
623667
<<<<<<< HEAD
668+
<<<<<<< HEAD
624669
<<<<<<< HEAD
625670
const [model] = await vscode.lm.selectChatModels(MODEL_SELECTOR);
626671

@@ -664,6 +709,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
664709
=======
665710
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
666711
=======
712+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
713+
=======
667714
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
668715
// initialize the messages array with the prompt
669716
const messages = [
@@ -698,6 +745,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
698745
<<<<<<< HEAD
699746
<<<<<<< HEAD
700747
<<<<<<< HEAD
748+
<<<<<<< HEAD
749+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
750+
=======
701751
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
702752
=======
703753
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

0 commit comments

Comments
 (0)