Skip to content

Commit fd3c776

Browse files
authored
changed files by pdets auto publish service, publishid[93d84693-a929-407e-9a19-35d0432f6910] and do [publish].
1 parent febd381 commit fd3c776

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/2-review-github-copilot-explain-document-features.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,25 @@ The following GitHub Copilot features can be used to generate inline code docume
2020

2121
- Edit mode: Use the edit mode to suggest inline code documentation for a code file, class, or method. Review the suggested documentation in the editor, navigating between suggested updates. Accept or reject individual suggestions, or modify suggestions as needed.
2222

23-
- Agent mode: Use the agent mode to autonomously generate inline code documentation for specified code projects, files, classes, or methods. Have the agent perform additional tasks during or after the documentation process. Accept or reject the updates when the agent has completed the assigned tasks.
23+
- Agent mode: Use the agent mode to autonomously generate inline code documentation for specified code projects, files, classes, or methods. Have the agent perform other tasks during or after the documentation process. Accept or reject the updates when the agent has completed the assigned tasks.
2424

25-
- Inline chat - Use an inline chat session to work directly in the code editor. The inline chat is useful when you want to document specific code (classes, methods, or code blocks) without leaving the editor. You can provide specific instructions in the prompt or use the `/doc` slash command without additional information if you want. Updates are displayed in the code editor and can be accepted or rejected. You can also choose the option to rerun the prompt with or without updates.
25+
- Inline chat - Use an inline chat session to work directly in the code editor. The inline chat is useful when you want to document specific code (classes, methods, or code blocks) without leaving the editor. You can provide specific instructions in the prompt or use the `/doc` slash command without specific information if you want. Updates are displayed in the code editor and can be accepted or rejected. You can also choose the option to rerun the prompt with or without updates.
2626

2727
- Generate Docs smart action: Use the Generate Docs smart action to generate inline code documentation for a selected class, method, or code block. The Generate Docs smart action is useful when you don't have specific requirements that would require a prompt. Updates are displayed in the code editor and can be accepted or rejected. You can also rerun the smart action.
2828

2929
## Generate project documentation using GitHub Copilot
3030

3131
The following GitHub Copilot features can be used to generate project documentation:
3232

33-
- Chat view in ask mode: Use the ask mode to analyze the codebase and gain an understanding of the code projects, files, and classes. Use ask mode to preview suggested project documentation. Review suggestions and request updates or additional details as needed. Insert the suggested documentation into a project documentation file (README.md).
33+
- Chat view in ask mode: Use the ask mode to analyze the codebase and gain an understanding of the code projects, files, and classes. Use ask mode to preview suggested project documentation. Review suggestions and request updates or other details as needed. Insert the suggested documentation into a project documentation file (README.md).
3434

3535
- Chat view in Edit mode: Generate a project documentation file (README.md).
3636

3737
- Chat view in agent mode: Generate a collection of project documentation files: create/update the README.md, create/update the UsageExamples.md, and create/update the ChangeLog.md. Include links between the documentation files, cross-reference classes and methods, and ensure consistency across docs.
3838

3939
> [!IMPORTANT]
40-
> When you use the Chat view in agent mode, GitHub Copilot may make multiple premium requests to complete a single task. This includes both user-initiated prompts and follow-up actions Copilot takes on your behalf. The total premium requests used will depend on the complexity of the task, the number of steps involved, and the model selected.
40+
> When you use the Chat view in agent mode, GitHub Copilot may make multiple premium requests to complete a single task. Premium requests can be used by user-initiated prompts and follow-up actions Copilot takes on your behalf. The total premium requests used will depend on the complexity of the task, the number of steps involved, and the model selected.
4141
4242
## Summary
4343

44-
GitHub Copilot helps you analyze and document your code quickly and accurately. The chat view, inline chat, quick chat, and smart action features provides various levels of interaction directly within the Visual Studio Code environment.
44+
GitHub Copilot helps you analyze and document your code quickly and accurately. The chat view, inline chat, quick chat, and smart action features provide various levels of interaction directly within the Visual Studio Code environment.

learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/4-analyze-explain-code-using-github-copilot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The ask mode supports the following interface features:
3131

3232
- Add Context button: The Add Context button is located in bottom section of the Chat view. You can use this button search for resources that add context to Chat session. The resources can be anything from internal project files to public repositories on GitHub that are external to your organization.
3333

34-
- Ask Copilot: The Ask Copilot text box is where you enter your prompts. When using the ask mode, prompts can include chat participants, slash commands, and chat variables.
34+
- Ask Copilot: The Ask Copilot text box is where you enter your prompts. When you're using ask mode, prompts can include chat participants, slash commands, and chat variables.
3535

3636
In ask mode, you can use chat participants to specify the context of your questions. For example, you can use `@workspace` to indicate that the context is your workspace files.
3737

@@ -61,7 +61,7 @@ You can use the inline chat to inquire about general coding topics, but it's bes
6161

6262
The inline chat supports the following features:
6363

64-
- Ask Copilot: The Ask Copilot text box is where you enter your prompts. When using the inline chat, prompts can include slash commands and chat variables, but chat participants aren't supported.
64+
- Ask Copilot: The Ask Copilot text box is where you enter your prompts. When you're using the inline chat, prompts can include slash commands and chat variables, but chat participants aren't supported.
6565

6666
- Chat with Extension button: The Chat with Extension button is located below the Ask Copilot textbox. GitHub Copilot Extensions are a type of GitHub App that integrates the power of external tools into GitHub Copilot Chat. You can use this button to select from a list of Copilot Extensions. The default extensions provide a combination of Chat participants and Slash commands that provide context for your prompts.
6767

learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/5-generate-project-documentation-using-github-copilot.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ GitHub Copilot's Chat view is an ideal tool for generating project documentation
55
You can use each of the Chat view modes (Ask, Edit, or Agent) to generate project documentation. Each mode has its own strengths and weaknesses. Project specifications and other constraints affect which mode should be used.
66

77
> [!IMPORTANT]
8-
> When you use the Chat view in agent mode, GitHub Copilot may make multiple premium requests to complete a single task. This includes both user-initiated prompts and follow-up actions Copilot takes on your behalf. The total premium requests used depends on the complexity of the task, the number of steps involved, and the model selected.
8+
> When you use the Chat view in agent mode, GitHub Copilot may make multiple premium requests to complete a single task. Premium requests can be used by user-initiated prompts and follow-up actions Copilot takes on your behalf. The total premium requests used depends on the complexity of the task, the number of steps involved, and the model selected.
99
1010
## Establish project documentation requirements
1111

@@ -36,7 +36,7 @@ Use the following process to generate project documentation using the ask mode:
3636

3737
1. Identify the documentation requirements and supporting resources.
3838

39-
- Identify the documentation requirements for your project. Identify the types of documentation as well as the required document sections.
39+
- Identify the documentation requirements for your project. Identify the types of documentation and the required document sections.
4040

4141
- Identify the resources required to generate the documentation. Your code workspace could be the only required resource. However, you may need to add context to the chat for sections like "Contributing", "Credits", and "Contact".
4242

@@ -55,7 +55,7 @@ Use the following process to generate project documentation using the ask mode:
5555

5656
1. Enter a prompt that asks for suggested project documentation, listing the required sections that you identified in the first step.
5757

58-
For example: "`@workspace /explain` I need need help creating a README file that can be used in the GitHub repository for this workspace. The file should be formatted as markdown. The README file needs to include the following sections: Project Title, Description, Table of Contents, Installation, Usage, Features, Configuration, and License."
58+
For example: "`@workspace /explain I need help creating a README file that can be used in the GitHub repository for this workspace. The file should be formatted as markdown. The README file needs to include the following sections: Project Title, Description, Table of Contents, Installation, Usage, Features, Configuration, and License.`"
5959

6060
1. Review the suggested project documentation, and refine the results using new prompts if necessary.
6161

learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/6-generate-inline-code-documentation-using-github-copilot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The Chat view in Agent mode can be used to generate inline code documentation fo
102102
103103
![Screenshot showing the Chat view in Agent mode showing status messages.](../media/chat-view-agent-mode-inline-docs-may-2025-status.png)
104104
105-
The agent may also request additional context or ask for assistance to complete the requested tasks. For example, the agent may ask for permission before running a command in the terminal.
105+
The agent may also request more context or ask for assistance to complete the requested tasks. For example, the agent may ask for permission before running a command in the terminal.
106106
107107
1. Wait for the agent to complete the requested documentation tasks, then review the updated files the editor.
108108

0 commit comments

Comments
 (0)