Skip to content

Commit 9a30b14

Browse files
committed
Acrolinx updates during PR review
1 parent a6b0c13 commit 9a30b14

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ The following GitHub Copilot features can be used to generate inline code docume
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 other details as needed. Insert the suggested documentation into a project documentation file (README.md).
33+
- Chat view in Ask agent mode: Use the Ask agent to analyze the codebase and gain an understanding of the code projects, files, and classes. The Ask agent can be used 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

35-
- Chat view in Plan mode: Create a detailed implementation plan for project documentation, then hand off to agent mode for execution.
35+
- Chat view in Plan agent mode: Create a detailed implementation plan for project documentation, then hand off to agent mode for execution.
3636

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.
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.
3838

3939
> [!IMPORTANT]
4040
> When you use the Chat view in agent mode, each prompt you enter counts as one premium request, multiplied by the model's multiplier. GitHub Copilot may take several follow-up actions to complete your task, but these follow-up actions don't count toward your premium request usage. Only the prompts you enter are billed. The total premium requests used depends on how many prompts you enter and the model selected. The Free Plan for GitHub Copilot gets 50 premium requests per month. Check plan descriptions for more details about premium request limits for each GitHub Copilot subscription.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,19 @@ For example, the README.md could include the following sections:
2828

2929
GitHub Copilot Chat can help you generate project documentation that meets the specific needs of your project and its stakeholders.
3030

31-
## Use the ask mode to generate project documentation
31+
## Use the Ask agent mode to generate project documentation
3232

33-
The ask mode can be used to analyze a workspace and then generate documentation.
33+
The Ask agent mode can be used to analyze a workspace and then generate documentation.
3434

35-
Use the following process to generate project documentation using the ask mode:
35+
Use the following process to generate project documentation using the Ask agent mode:
3636

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

3939
- 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

43-
1. Open the Chat view and start a new chat session using the ask mode.
43+
1. Open the Chat view and start a new chat session using the Ask agent mode.
4444

4545
1. Add context to the chat session.
4646

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

5050
1. Enter a series of prompts that investigate your documentation requirements.
5151

52-
You can use the ask mode to analyze the workspace and build a chat session history that supports your documentation requirements. Describing your goals can help establish context for the chat session. Asking questions that address your requirements helps GitHub Copilot identify the information needed to generate the documentation.
52+
You can use the Ask agent mode to analyze the workspace and build a chat session history that supports your documentation requirements. Describing your goals can help establish context for the chat session. Asking questions that address your requirements helps GitHub Copilot identify the information needed to generate the documentation.
5353

5454
Refresh the added context as needed.
5555

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

6464
For example, create a README.md file at the root of the workspace, and the insert the suggested content into the file.
6565

66-
You can use the ask mode to suggest updates for specific sections of your project after creating the document, or use other GitHub Copilot tools to help with updates.
66+
You can use the Ask agent mode to suggest updates for specific sections of your project after creating the document, or use other GitHub Copilot tools to help with updates.
6767

6868
## Use the Plan mode to generate project documentation
6969

@@ -137,4 +137,4 @@ Agent mode is ideal for project-wide, multi-file, and context-aware documentatio
137137

138138
## Summary
139139

140-
GitHub Copilot can help you generate project documentation that meets the specific needs of your project and its stakeholders. The Chat view can be used to generate project documentation in three different modes: Ask, Agent, and Plan. Each mode has its own strengths and weaknesses, and the best mode to use depends on the specific task at hand. The ask mode is best for asking questions about your codebase or technology concepts. The agent mode is best for generating project documentation that requires an in-depth understanding of the project. The Plan mode is best for creating a detailed implementation plan before generating documentation, which can then be handed off to agent mode for execution.
140+
GitHub Copilot can help you generate project documentation that meets the specific needs of your project and its stakeholders. The Chat view can be used to generate project documentation in three different modes: Ask, Agent, and Plan. Each mode has its own strengths and weaknesses, and the best mode to use depends on the specific task at hand. The Ask agent mode is best for asking questions about your codebase or technology concepts. The Agent mode is best for generating project documentation that requires an in-depth understanding of the project. The Plan mode is best for creating a detailed implementation plan before generating documentation, which can then be handed off to Agent mode for execution.

learn-pr/wwl-azure/implement-code-improvements-using-github-copilot-tools/includes/6-refactor-code-github-copilot-chat-modes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Consider the following criteria to choose between Plan and Agent:
130130
- Task complexity: The Agent is better suited for complex tasks that require both code edits and the invocation of tools or terminal commands.
131131
- Duration: The Agent uses multiple steps to process a request, so it might take longer to generate a response. For example, to determine the relevant context and files to edit, determine the plan of action, and more.
132132
- Self-healing: The Agent evaluates the outcome of the generated edits and might iterate multiple times to resolve intermediate issues.
133-
- Request quota: When using the Agent, depending on the complexity of the task, one prompt might result in many requests to the backend.
133+
- Request quota: When using the Agent mode, depending on the complexity of the task, one prompt might result in many requests to the backend.
134134
135135
## Summary
136136

0 commit comments

Comments
 (0)