jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-23 11:54:18 -05:00
Code Issues Projects Releases Wiki Activity

Move Copilot variables from product.yml to copilot.yml (#55832)

Browse Source 
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: hubwriter <54933897+hubwriter@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: felicitymay <1877141+felicitymay@users.noreply.github.com>
Co-authored-by: Felix Guntrip <stevecat@github.com>
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
Co-authored-by: Ebonsignori <17055832+Ebonsignori@users.noreply.github.com>
This commit is contained in:
Copilot
2025-06-02 11:35:54 +01:00
committed by GitHub
parent 82ad892a34
commit ec7bb4d9bb
347 changed files with 1868 additions and 1863 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/copilot/copilot-chat-cookbook/documenting-code/documenting-legacy-code.md
View File

@@ -1,7 +1,7 @@
---
title: 'Documenting legacy code'
shortTitle: Document legacy code
intro: '{% data variables.product.prodname_copilot_chat_short %} can help with documenting legacy code.'
intro: '{% data variables.copilot.copilot_chat_short %} can help with documenting legacy code.'
redirect_from:
- /copilot/example-prompts-for-github-copilot-chat/documenting-code/documenting-legacy-code
versions:
@@ -71,7 +71,7 @@ INSERT-AND-VALIDATE.
## Example prompt
We can use a simple prompt to ask {% data variables.product.prodname_copilot_chat_short %} to document the code.
We can use a simple prompt to ask {% data variables.copilot.copilot_chat_short %} to document the code.
`Document this code`

6
content/copilot/copilot-chat-cookbook/documenting-code/explaining-complex-algorithms-or-logic.md
View File

@@ -1,7 +1,7 @@
---
title: 'Explaining complex algorithms or logic'
shortTitle: Explain complex logic
intro: '{% data variables.product.prodname_copilot_chat_short %} can help add clear and concise documentation on complex algorithms or logic.'
intro: '{% data variables.copilot.copilot_chat_short %} can help add clear and concise documentation on complex algorithms or logic.'
redirect_from:
- /copilot/example-prompts-for-github-copilot-chat/documenting-code/explaining-complex-algorithms-or-logic
versions:
@@ -15,7 +15,7 @@ topics:
- Copilot
---
There may be times where you need to explain complex algorithms or logic in your code. This can be challenging, especially when you're trying to make it understandable to others. {% data variables.product.prodname_copilot_chat_short %} can help you with this task by providing you with suggestions on how to explain the algorithm or logic in a clear and concise manner.
There may be times where you need to explain complex algorithms or logic in your code. This can be challenging, especially when you're trying to make it understandable to others. {% data variables.copilot.copilot_chat_short %} can help you with this task by providing you with suggestions on how to explain the algorithm or logic in a clear and concise manner.
## Example scenario
@@ -76,7 +76,7 @@ private void UpdateStatusLabel(string message, Label statusLabel)
## Example prompt
We can ask {% data variables.product.prodname_copilot_chat_short %} to make this code easier to understand using comments.
We can ask {% data variables.copilot.copilot_chat_short %} to make this code easier to understand using comments.
`Add comments to this code to make it more understandable`

6
content/copilot/copilot-chat-cookbook/documenting-code/explaining-legacy-code.md
View File

@@ -1,7 +1,7 @@
---
title: 'Explaining legacy code'
shortTitle: Explain legacy code
intro: '{% data variables.product.prodname_copilot_chat_short %} can help with explaining unfamiliar code.'
intro: '{% data variables.copilot.copilot_chat_short %} can help with explaining unfamiliar code.'
redirect_from:
- /copilot/example-prompts-for-github-copilot-chat/documenting-code/explaining-legacy-code
versions:
@@ -15,11 +15,11 @@ topics:
- Copilot
---
One of the biggest challenges with legacy code is helping developers understand it who aren't familiar with the languages or frameworks. With {% data variables.product.prodname_copilot_chat_short %}, you can explain the background you have and ask for an explanation.
One of the biggest challenges with legacy code is helping developers understand it who aren't familiar with the languages or frameworks. With {% data variables.copilot.copilot_chat_short %}, you can explain the background you have and ask for an explanation.
## Example scenario
Consider the following COBOL code. If you're a Python developer (as an example), you might not be familiar with COBOL, so you could ask {% data variables.product.prodname_copilot_chat_short %} to explain the code to you.
Consider the following COBOL code. If you're a Python developer (as an example), you might not be familiar with COBOL, so you could ask {% data variables.copilot.copilot_chat_short %} to explain the code to you.
```text
IDENTIFICATION DIVISION.

2
content/copilot/copilot-chat-cookbook/documenting-code/index.md
View File

@@ -1,6 +1,6 @@
---
title: Documenting code
intro: 'Discover ways that you can use {% data variables.product.prodname_copilot_chat %} to document your code.'
intro: 'Discover ways that you can use {% data variables.copilot.copilot_chat %} to document your code.'
redirect_from:
- /copilot/example-prompts-for-github-copilot-chat/documenting-code
versions:

6
content/copilot/copilot-chat-cookbook/documenting-code/syncing-documentation-with-code-changes.md
View File

@@ -1,7 +1,7 @@
---
title: 'Syncing documentation with code changes'
shortTitle: Sync documentation
intro: '{% data variables.product.prodname_copilot_chat_short %} can help with keeping code documentation up-to-date.'
intro: '{% data variables.copilot.copilot_chat_short %} can help with keeping code documentation up-to-date.'
redirect_from:
- /copilot/example-prompts-for-github-copilot-chat/documenting-code/syncing-documentation-with-code-changes
versions:
@@ -15,7 +15,7 @@ topics:
- Copilot
---
It can be difficult to keep documentation up to date with changes to code. However, good documentation is essential for maintaining codebases and ensuring that developers can work effectively with the code. {% data variables.product.prodname_copilot_chat_short %} can assist in updating existing code documentation.
It can be difficult to keep documentation up to date with changes to code. However, good documentation is essential for maintaining codebases and ensuring that developers can work effectively with the code. {% data variables.copilot.copilot_chat_short %} can assist in updating existing code documentation.
## Example scenario
@@ -52,7 +52,7 @@ async getByCategoryName(categoryId: number, page = 1, pageSize = 10): Promise<Pr
## Example prompt
You can ask {% data variables.product.prodname_copilot_chat_short %} to update the documentation according to the current code.
You can ask {% data variables.copilot.copilot_chat_short %} to update the documentation according to the current code.
`Update the existing documentation for the getByCategoryName function to reflect the current implementation.`

26
content/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts.md
View File

@@ -1,7 +1,7 @@
---
title: Writing discussions or blog posts
shortTitle: Write discussions or blog posts
intro: '{% data variables.product.prodname_copilot_chat_short %} can help you generate ideas, outline, or draft discussions or blog posts.'
intro: '{% data variables.copilot.copilot_chat_short %} can help you generate ideas, outline, or draft discussions or blog posts.'
versions:
feature: copilot
category:
@@ -13,17 +13,17 @@ topics:
- Copilot
---
When you're working on code, you often need to quickly create accurate and comprehensive explanations to share your work with teammates or the broader community. {% data variables.product.prodname_copilot_chat_short %} can help by suggesting ideas, outlines, or complete drafts for discussions or blog posts—enabling you to document and communicate clearly, so you can spend more time focused on coding.
When you're working on code, you often need to quickly create accurate and comprehensive explanations to share your work with teammates or the broader community. {% data variables.copilot.copilot_chat_short %} can help by suggesting ideas, outlines, or complete drafts for discussions or blog posts—enabling you to document and communicate clearly, so you can spend more time focused on coding.
>[!TIP] You can include links to specific pull requests or issues in your prompts to give {% data variables.product.prodname_copilot_chat_short %} more context. If you're not getting the results you expect, try specifying the repository in your prompt to help {% data variables.product.prodname_copilot_chat_short %} focus on the right project.
>[!TIP] You can include links to specific pull requests or issues in your prompts to give {% data variables.copilot.copilot_chat_short %} more context. If you're not getting the results you expect, try specifying the repository in your prompt to help {% data variables.copilot.copilot_chat_short %} focus on the right project.
## Generating ideas
When you're working on a project, you may need to write a discussion or blog post to share your ideas, get feedback, or communicate with your team. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas.
When you're working on a project, you may need to write a discussion or blog post to share your ideas, get feedback, or communicate with your team. {% data variables.copilot.copilot_chat_short %} can help you generate ideas.
### Brainstorming topics from recent work
If you're looking for ideas for a discussion post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest topics based on your recent work.
If you're looking for ideas for a discussion post, you can ask {% data variables.copilot.copilot_chat_short %} to suggest topics based on your recent work.
#### Example prompts
@@ -37,7 +37,7 @@ If you're looking for ideas for a discussion post, you can ask {% data variables
### Writing technical deep dives
When you're working on a complex feature or system, you may need to write a technical deep dive to share your work with your team or the broader community. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas for technical deep dives by suggesting topics based on your recent work.
When you're working on a complex feature or system, you may need to write a technical deep dive to share your work with your team or the broader community. {% data variables.copilot.copilot_chat_short %} can help you generate ideas for technical deep dives by suggesting topics based on your recent work.
#### Example prompts
@@ -49,7 +49,7 @@ When you're working on a complex feature or system, you may need to write a tech
### Sharing best practices
When you're working on a project, you may need to write a discussion post to share best practices or lessons learned. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas for discussion posts.
When you're working on a project, you may need to write a discussion post to share best practices or lessons learned. {% data variables.copilot.copilot_chat_short %} can help you generate ideas for discussion posts.
#### Example prompt
@@ -57,11 +57,11 @@ When you're working on a project, you may need to write a discussion post to sha
## Drafting content
Once you have an idea for a discussion or blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to help you draft the content. {% data variables.product.prodname_copilot_chat_short %} can provide you with a detailed outline, a rough draft, or a polished draft, depending on your needs.
Once you have an idea for a discussion or blog post, you can ask {% data variables.copilot.copilot_chat_short %} to help you draft the content. {% data variables.copilot.copilot_chat_short %} can provide you with a detailed outline, a rough draft, or a polished draft, depending on your needs.
### Outlining a blog post
If you're looking for help outlining a blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest a detailed outline for your post.
If you're looking for help outlining a blog post, you can ask {% data variables.copilot.copilot_chat_short %} to suggest a detailed outline for your post.
#### Example prompt
@@ -69,7 +69,7 @@ If you're looking for help outlining a blog post, you can ask {% data variables.
### Drafting a blog post
If you're looking for help drafting a blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest a rough draft for your post.
If you're looking for help drafting a blog post, you can ask {% data variables.copilot.copilot_chat_short %} to suggest a rough draft for your post.
#### Example prompts
@@ -81,11 +81,11 @@ If you're looking for help drafting a blog post, you can ask {% data variables.p
## Refining your draft
Once you have a draft, you can ask {% data variables.product.prodname_copilot_chat_short %} to help you refine it. {% data variables.product.prodname_copilot_chat_short %} can provide you with suggestions for improving your writing, making it more engaging, or clarifying complex concepts.
Once you have a draft, you can ask {% data variables.copilot.copilot_chat_short %} to help you refine it. {% data variables.copilot.copilot_chat_short %} can provide you with suggestions for improving your writing, making it more engaging, or clarifying complex concepts.
### Improving tone and style
If you're looking to improve the tone and style of your writing, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest ways to make your writing more engaging or accessible.
If you're looking to improve the tone and style of your writing, you can ask {% data variables.copilot.copilot_chat_short %} to suggest ways to make your writing more engaging or accessible.
#### Example prompt
@@ -93,7 +93,7 @@ If you're looking to improve the tone and style of your writing, you can ask {%
### Including next steps
If you're looking to include next steps in your blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest ways to make your writing more actionable.
If you're looking to include next steps in your blog post, you can ask {% data variables.copilot.copilot_chat_short %} to suggest ways to make your writing more actionable.
#### Example prompt