Skip to content

Commit 41262f3

Browse files
authored
Merge pull request #7821 from microsoft/inline-chat-casing
Miscellaneous minor text edits
2 parents 49bc7a1 + 03639b0 commit 41262f3

File tree

10 files changed

+31
-20
lines changed

10 files changed

+31
-20
lines changed

docs/copilot/ai-powered-suggestions.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,20 @@ GitHub Copilot acts as an AI-powered pair programmer, automatically offering sug
1414

1515
## Getting started
1616

17-
> **Note**: After reviewing this topic, you can get started with the introductory [Copilot getting started tutorial](/docs/copilot/getting-started.md) to get set up and take a hands-on tour of Copilot in VS Code.
17+
1. Install the GitHub Copilot extension. This also installs the GitHub Copilot Chat extension.
1818

19-
* To use GitHub Copilot, you must have an active subscription for GitHub Copilot in your personal account, or you need to be assigned a seat by your organization.
19+
> <a class="install-extension-btn" href="vscode:extension/GitHub.copilot">Install the GitHub Copilot extension</a>
2020
21-
* To use GitHub Copilot in VS Code, you must have the [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) extension. When you install this extension, the [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) extension is also installed.
21+
1. Follow the steps in the [Copilot setup guide](/docs/copilot/setup.md) to configure GitHub Copilot in VS Code.
2222

23-
Follow these steps to [set up GitHub Copilot in VS Code](/docs/copilot/setup.md) by signing up for a subscription and installing the Copilot extension in VS Code.
23+
> [!TIP]
24+
> If you don't yet have a GitHub Copilot subscription, sign up for a [GitHub Copilot free trial](https://github.com/login?return_to=%2fgithub-copilot%2fsignup) in your personal account.
25+
26+
1. Get going with these hands-on tutorials to learn how to use GitHub Copilot in VS Code.
27+
28+
* [GitHub Copilot Quickstart](/docs/copilot/getting-started.md) - discover the key features of GitHub Copilot in VS Code.
29+
30+
* [Copilot Chat Tutorial](/docs/copilot/getting-started-chat.md) - get started with AI chat conversations.
2431

2532
## Inline suggestions
2633

docs/copilot/copilot-vscode-features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,8 +219,8 @@ Get help about shell commands and how to resolve errors when running commands in
219219
| `kb(inlinechat.start)` | Start Inline Chat within the terminal to use natural language to quickly get and run a shell command.<br/>Example: `how many cores on this machine?` |
220220
| <i class="codicon codicon-sparkle"></i> <br/>Fix using Copilot | Select the <i class="codicon codicon-sparkle"></i> icon on a failed shell command and get suggestions on how to resolve the error. |
221221
| <i class="codicon codicon-sparkle"></i> <br/>Explain using Copilot | Select the <i class="codicon codicon-sparkle"></i> icon on a failed shell command and get an explanation about why the command failed. |
222-
| `@terminal` | Use the `@terminal` participant in the Chat View to ask questions about the integrated terminal or shell commands.<br/>Example: `@terminal list the 5 largest files in this workspace` |
223-
| `@terminal /explain` | Use the `/explain` command in the Chat View to explain something from the terminal.<br/>Example: `@terminal /explain top shell command` |
222+
| `@terminal` | Use the `@terminal` participant in the Chat view to ask questions about the integrated terminal or shell commands.<br/>Example: `@terminal list the 5 largest files in this workspace` |
223+
| `@terminal /explain` | Use the `/explain` command in the Chat view to explain something from the terminal.<br/>Example: `@terminal /explain top shell command` |
224224

225225
## Python and Notebook support
226226

docs/copilot/getting-started-chat.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ TOCTitle: Copilot Chat Tutorial
55
ContentId: ae1f36a9-7597-425f-97fc-49bd51c153a3
66
PageTitle: Getting started with Copilot Chat
77
DateApproved: 10/29/2024
8-
MetaDescription: Get started with AI-powered chat conversations with GitHub Copilot in Visual Studio Code, inline while you're coding, or in a separate chat view.
8+
MetaDescription: Get started with AI-powered chat conversations with GitHub Copilot in Visual Studio Code, inline while you're coding, or in a separate Chat view.
99
MetaSocialImage: images/shared/github-copilot-social.png
1010
---
1111
# Getting started with Copilot Chat in VS Code
@@ -78,7 +78,8 @@ Let's iterate on our generated Express app and add a new page to it.
7878

7979
![Screenshot of VS Code Copilot Chat view, showing the list of chat participants.](./images/getting-started-chat/copilot-chat-view-participants.png)
8080

81-
> **Note**: Extensions can also contribute chat participants, so the list might vary based on the extensions you have installed in VS Code.
81+
> [!NOTE]
82+
> Extensions can also contribute chat participants, so the list might vary based on the extensions you have installed in VS Code.
8283
8384
1. Let's use `@vscode` to ask about VS Code. Enter `@vscode how to debug node.js app` in the chat input field.
8485

docs/copilot/getting-started.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ MetaSocialImage: images/shared/github-copilot-social.png
1212

1313
This tutorial walks you through the key features of GitHub Copilot in Visual Studio Code. Learn how to get started with the [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) extension to get AI-powered code suggestions in the editor, use chat conversations to refactor your code, and fix code errors with smart actions.
1414

15-
> **Note:** While we're using TypeScript for this tutorial, please note that Copilot is also trained on numerous other languages and a wide variety of frameworks.
15+
> [!NOTE]
16+
> While we're using TypeScript for this tutorial, please note that Copilot is also trained on numerous other languages and a wide variety of frameworks.
1617
1718
For an overview of what you can do with GitHub Copilot in VS Code, see the [GitHub Copilot Overview](/docs/copilot/overview.md).
1819

docs/copilot/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,17 +129,17 @@ Check our [Copilot cheat sheet](/docs/copilot/copilot-vscode-features.md) for an
129129

130130
* **Provide suggestions for implementing code refactorings**. Copilot suggests refactorings using the context of your codebase. For example, ask Copilot to refactor a function to not use recursion, or to suggest an algorithm that can improve performance.
131131

132-
![Inline chat refactoring to use different sorting algorithm](images/overview/inline-chat-convert-sort.png)
132+
![Inline Chat refactoring to use different sorting algorithm](images/overview/inline-chat-convert-sort.png)
133133

134134
* **Suggest potential improvements to selected code**, such as improved handling of errors and edge cases, or changes to the logical flow to make the code more readable.
135135

136-
![Copilot inline chat suggesting improvements to error handling](images/overview/copilot-inline-chat-error-handling.png)
136+
![Copilot Inline Chat suggesting improvements to error handling](images/overview/copilot-inline-chat-error-handling.png)
137137

138138
### Fix issues
139139

140140
* **Propose a fix for bugs in your code** with the `/fix` command by suggesting code snippets and solutions based on the context of the error or issue. For example, if your code produces an error message or warning, Copilot Chat can suggest possible fixes based on the error message, the code's syntax, and the surrounding code. The changes might consist of changes to variables, control structures, or function calls that could resolve the issue.
141141

142-
![Inline chat /fix for an error proposing to install a missing library](images/overview/inline-chat-fix-error-message-example.png)
142+
![Inline Chat /fix for an error proposing to install a missing library](images/overview/inline-chat-fix-error-message-example.png)
143143

144144
* **Propose a fix for failing tests** (preview). When you run automated tests for your code, Copilot can suggest code fixes for tests that fail with the `/fixTestFailure` command.
145145

@@ -197,7 +197,7 @@ Check our [Copilot cheat sheet](/docs/copilot/copilot-vscode-features.md) for an
197197

198198
![Search view showing semantic search results that are not an exact match for the search criteria.](images/overview/semantic-search-results.png)
199199

200-
* **Use terminal inline chat** to ask questions about the terminal or how to use specific shell commands. For example, you can ask questions such as "list the top 5 largest files in the src directory", or "how to enable shell integration".
200+
* **Use terminal Inline Chat** to ask questions about the terminal or how to use specific shell commands. For example, you can ask questions such as "list the top 5 largest files in the src directory", or "how to enable shell integration".
201201

202202
![Screenshot showing that you can ask complex questions like "list the top 5 largest files in the src dir"](images/overview/terminal-chat-2.png)
203203

docs/copilot/prompt-crafting.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ MetaSocialImage: images/shared/github-copilot-social.png
1212

1313
This article covers best practices for using GitHub Copilot in Visual Studio Code by using prompt crafting and providing the right context to GitHub Copilot.
1414

15-
>**Note**: "Prompt engineering" or "Prompt crafting" is a common phrase you'll hear when discussing AI and refers to how and what information is packaged and sent to an AI API endpoint. The Copilot extension does this process for you but you can help by providing hints to guide the extension.
15+
> [!NOTE]
16+
> "Prompt engineering" or "Prompt crafting" is a common phrase you'll hear when discussing AI and refers to how and what information is packaged and sent to an AI API endpoint. The Copilot extension does this process for you but you can help by providing hints to guide the extension.
1617
1718
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/hh1nOX14TyY" title="Core principles of prompt engineering with GitHub Copilot" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
1819

@@ -111,7 +112,7 @@ Chat participants are designed to collect extra context either about a code base
111112

112113
Slash commands help Copilot Chat understand your **intent** when you ask a question. Are you learning about a code base (`/explain`), do you want help with fixing an issue (`/fix`), or are you creating test cases (`/tests`)? By letting Copilot Chat know what you're trying to do, it can tune its reply to your task and provide helpful commands, settings, and code snippets.
113114

114-
![Inline chat slash command list](images/prompt-crafting/inline-chat-slash-commands.png)
115+
![Inline Chat slash command list](images/prompt-crafting/inline-chat-slash-commands.png)
115116

116117
You could write out your project scope or current task with a natural language query but using chat participants and slash commands is more concise and explicit.
117118

@@ -139,7 +140,7 @@ When you ask Copilot to do a specific task, be specific about the inputs, output
139140

140141
When asking Copilot Chat for help, you aren't stuck with the first response. You can iterate and prompt Copilot to improve the solution. Copilot has both the context of the generated code and also your current conversation.
141142

142-
Here's an example using inline chat to create a function to calculate Fibonacci numbers:
143+
Here's an example using Inline Chat to create a function to calculate Fibonacci numbers:
143144

144145
![First response from Copilot for a function to calculate Fibonacci numbers](images/prompt-crafting/fibonacci-first.png)
145146

docs/copilot/workspace-context.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ To answer your question, `@workspace` searches through the same sources a develo
3535
- Symbols and definitions in the workspace
3636
- Currently selected text or visible text in the active editor
3737

38-
**Note**: `.gitignore` is bypassed if you have a file open or have text selected within an ignored file.
38+
> [!NOTE]
39+
> `.gitignore` is bypassed if you have a file open or have text selected within an ignored file.
3940
4041
## How does `@workspace` find the most relevant context
4142

docs/editor/accessibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When you adjust the zoom level with the **View** > **Appearance** > **Zoom In /
2929

3030
## Accessibility help
3131

32-
The command **Open Accessibility Help** `kb(editor.action.accessibilityHelp)` opens a help menu based on the current context. It currently applies to the editor, terminal, notebook, chat view, and inline chat features.
32+
The command **Open Accessibility Help** `kb(editor.action.accessibilityHelp)` opens a help menu based on the current context. It currently applies to the editor, terminal, notebook, Chat view, and Inline Chat features.
3333

3434
You can dismiss the accessibility help menu or open additional documentation from within the help menu.
3535

docs/editor/voice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You can press and hold the keybinding for the voice start command (`kb(workbench
2727

2828
## Voice in Copilot Chat
2929

30-
You can use your voice to talk to [Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) easily. The command **Voice: Start Voice Chat** (`kb(workbench.action.chat.startVoiceChat)`) brings up a voice chat, regardless of where the current focus is. If the focus is in the editor, inline chat is started, otherwise the Chat view is opened.
30+
You can use your voice to talk to [Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) easily. The command **Voice: Start Voice Chat** (`kb(workbench.action.chat.startVoiceChat)`) brings up a voice chat, regardless of where the current focus is. If the focus is in the editor, Inline Chat is started, otherwise the Chat view is opened.
3131

3232
![Screenshot of the chat input field showing an active microphone icon to enter a voice chat message](images/accessibility/voice-chat.png)
3333

docs/terminal/basics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ You can also right-click on a terminal tab and select **Toggle Size to Content W
316316

317317
The basics of the terminal have been covered in this document. Read on to find out more about:
318318

319-
* [Terminal inline chat](/docs/copilot/copilot-chat#terminal-inline-chat) - AI-powered suggestions right in your terminal.
319+
* [Terminal Inline Chat](/docs/copilot/copilot-chat#terminal-inline-chat) - AI-powered suggestions right in your terminal.
320320
* [Tasks](/docs/editor/tasks.md) - Tasks let you integrate with external tools and leverage the terminal heavily.
321321
* [Mastering VS Code's Terminal](https://www.growingwiththeweb.com/2017/03/mastering-vscodes-terminal.html) - An external blog with plenty of power user tips for the terminal.
322322
* Explore terminal commands by browsing the keyboard shortcuts within VS Code (**Preferences: Open Keyboard Shortcuts** then search on 'terminal').

0 commit comments

Comments
 (0)