You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/2-review-github-copilot-explain-document-features.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,25 +20,25 @@ The following GitHub Copilot features can be used to generate inline code docume
20
20
21
21
- 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.
22
22
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.
24
24
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.
26
26
27
27
- 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.
28
28
29
29
## Generate project documentation using GitHub Copilot
30
30
31
31
The following GitHub Copilot features can be used to generate project documentation:
32
32
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).
34
34
35
35
- Chat view in Edit mode: Generate a project documentation file (README.md).
36
36
37
37
- 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.
38
38
39
39
> [!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.
41
41
42
42
## Summary
43
43
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.
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/4-analyze-explain-code-using-github-copilot.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ The ask mode supports the following interface features:
31
31
32
32
- 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.
33
33
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.
35
35
36
36
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.
37
37
@@ -61,7 +61,7 @@ You can use the inline chat to inquire about general coding topics, but it's bes
61
61
62
62
The inline chat supports the following features:
63
63
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.
65
65
66
66
- 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.
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/5-generate-project-documentation-using-github-copilot.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ GitHub Copilot's Chat view is an ideal tool for generating project documentation
5
5
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.
6
6
7
7
> [!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.
9
9
10
10
## Establish project documentation requirements
11
11
@@ -36,7 +36,7 @@ Use the following process to generate project documentation using the ask mode:
36
36
37
37
1. Identify the documentation requirements and supporting resources.
38
38
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.
40
40
41
41
- 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".
42
42
@@ -55,7 +55,7 @@ Use the following process to generate project documentation using the ask mode:
55
55
56
56
1. Enter a prompt that asks for suggested project documentation, listing the required sections that you identified in the first step.
57
57
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.`"
59
59
60
60
1. Review the suggested project documentation, and refine the results using new prompts if necessary.
Copy file name to clipboardExpand all lines: learn-pr/wwl-azure/generate-documentation-using-github-copilot-tools/includes/6-generate-inline-code-documentation-using-github-copilot.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,7 +102,7 @@ The Chat view in Agent mode can be used to generate inline code documentation fo
102
102
103
103

104
104
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.
106
106
107
107
1. Wait for the agent to complete the requested documentation tasks, then review the updated files the editor.
0 commit comments