Copilot: Add new prompt formatting to Markdown files (#57347)

Co-authored-by: Sarah Schneider <[email protected]>
Co-authored-by: Sarah Schneider <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

content/copilot/concepts/ai-tools.md

@@ -45,7 +45,7 @@ On {% data variables.product.github %}, use **{% data variables.product.prodname
 
 Once you've chosen an issue to address, **{% data variables.copilot.copilot_chat_short %}** can help you brainstorm ideas for your project and learn about the various tools, libraries, and resources you might need. You can ask {% data variables.copilot.copilot_chat_short %} generalized questions about the project you're envisioning to get suggestions on a path forward. For example:
 
-> I'd like to build an web app that helps users track their daily habits and provides personalized recommendations. Can you suggest features and technologies I could use?
+`I'd like to build an web app that helps users track their daily habits and provides personalized recommendations. Can you suggest features and technologies I could use?`
 
 ## Creation
 
@@ -59,27 +59,27 @@ With **{% data variables.copilot.next_edit_suggestions %}** ({% data variables.r
 
 Use {% data variables.copilot.copilot_chat_short %} in **ask mode** as your pair programmer to get help with coding tasks, understand tricky concepts, and improve your code. You can ask it questions, get explanations, or request suggestions in real time.
 
-> Can you explain what this JavaScript function does? I'm not sure why it uses a `forEach` loop instead of a `for` loop.
+* `Can you explain what this JavaScript function does? I'm not sure why it uses a forEach loop instead of a for loop.`
 
-> What’s the difference between `let`, `const`, and `var` in JavaScript? When should I use each one?
+* `What’s the difference between let, const, and var in JavaScript? When should I use each one?`
 
 ### Using {% data variables.copilot.copilot_chat_short %} in edit mode
 
 Use {% data variables.copilot.copilot_chat_short %} in **edit mode** when you want more granular control over the edits that {% data variables.product.prodname_copilot_short %} proposes. In edit mode, you choose which files {% data variables.product.prodname_copilot_short %} can make changes to, provide context to {% data variables.product.prodname_copilot_short %} with each iteration, and decide whether or not to accept the suggested edits.
 
-> Refactor the `calculateTotal` function to improve readability and efficiency.
+* `Refactor the calculateTotal function to improve readability and efficiency.`
 
-> The login function is not working as expected. Can you debug it?
+* `The login function is not working as expected. Can you debug it?`
 
-> Format this code to follow Python’s PEP 8 style guide.
+* `Format this code to follow Python’s PEP 8 style guide.`
 
 ### Using {% data variables.copilot.copilot_chat_short %} in agent mode
 
 In **agent mode**, {% data variables.copilot.copilot_chat_short %} can assist with automating repetitive tasks and managing your workflow directly within your project. Use it to create pull requests after you make code changes. You can also use it to run tests and linters in the background while you're working on your project.
 
-  > Create a pull request for the recent changes in the `user-auth` module and include a summary of the updates.
+* `Create a pull request for the recent changes in the user-auth module and include a summary of the updates.`
 
-  > Run all tests and linters for the `payment-processing` module and provide a summary of any issues or errors found.
+* `Run all tests and linters for the payment-processing module and provide a summary of any issues or errors found.`
 
 ## Reviews
 
@@ -98,25 +98,25 @@ The testing phase validates that your application works as intended. This phase
 
 **{% data variables.copilot.copilot_chat_short %}** can assist by generating unit and integration tests, debugging failures, and suggesting additional test cases to ensure comprehensive coverage. Here are some example prompts:
 
-> Write unit tests for this function to calculate the factorial of a number. Include edge cases like 0 and negative numbers.
+* `Write unit tests for this function to calculate the factorial of a number. Include edge cases like 0 and negative numbers.`
 
-> How do I run these tests using Python's unittest framework?
+* `How do I run these tests using Python's unittest framework?`
 
-> Write integration tests for the `deposit` function in the BankAccount class. Use mocks to simulate the NotificationSystem.
+* `Write integration tests for the deposit function in the BankAccount class. Use mocks to simulate the NotificationSystem.`
 
-> What additional tests should I include to ensure full coverage for this module?
+* `What additional tests should I include to ensure full coverage for this module?`
 
 ## Deployment
 
 The deployment phase involves preparing your code for production and ensuring a smooth release.
 
 **{% data variables.copilot.copilot_chat_short %}** can help you configure deployment scripts, set up CI/CD pipelines, and troubleshoot issues. Here are some example prompts:
 
-> Write a deployment script for a Node.js application using GitHub Actions to deploy to an AWS EC2 instance.
+* `Write a deployment script for a Node.js application using GitHub Actions to deploy to an AWS EC2 instance.`
 
-> Set up a GitHub Actions workflow to build, test, and deploy a Python application to Heroku.
+* `Set up a GitHub Actions workflow to build, test, and deploy a Python application to Heroku.`
 
-> Analyze this deployment log and suggest why the deployment failed.
+* `Analyze this deployment log and suggest why the deployment failed.`
 
 ## Operation
 
@@ -126,11 +126,11 @@ You can use the **{% data variables.copilot.copilot_coding_agent %}** ({% data v
 
 For issues you're tackling yourself, use **{% data variables.copilot.copilot_chat_short %}** for help analyzing logs, debugging issues, and suggesting optimizations. For example:
 
-> Analyze this error log and suggest possible causes for the issue.
+* `Analyze this error log and suggest possible causes for the issue.`
 
-> Write a script to monitor the memory usage of this application and alert when it exceeds a threshold.
+* `Write a script to monitor the memory usage of this application and alert when it exceeds a threshold.`
 
-> How can I optimize the database queries in this code to improve performance?
+* `How can I optimize the database queries in this code to improve performance?`
 
 ## Next steps
 

content/copilot/concepts/prompt-engineering.md

@@ -23,34 +23,38 @@ When writing a prompt for {% data variables.product.prodname_copilot_short %}, f
 
 For example:
 
-> Write a function that tells me if a number is prime
->
-> The function should take an integer and return true if the integer is prime
->
-> The function should error if the input is not a positive integer
+```copilot copy prompt
+Write a JavaScript function that tells me if a number is prime
+
+The function should take an integer and return true if the integer is prime
+
+The function should error if the input is not a positive integer
+```
 
 ## Give examples
 
 Use examples to help {% data variables.product.prodname_copilot_short %} understand what you want. You can provide example input data, example outputs, and example implementations.
 
 For example:
 
-> Write a function that finds all dates in a string and returns them in an array. Dates can be formatted like:
->
-> * 05/02/24
-> * 05/02/2024
-> * 5/2/24
-> * 5/2/2024
-> * 05-02-24
-> * 05-02-2024
-> * 5-2-24
-> * 5-2-2024
->
-> Example:
->
-> findDates("I have a dentist appointment on 11/14/2023 and book club on 12-1-23")
->
-> Returns: ["11/14/2023", "12-1-23"]
+```copilot copy prompt
+Write a Go function that finds all dates in a string and returns them in an array. Dates can be formatted like:
+
+* 05/02/24
+* 05/02/2024
+* 5/2/24
+* 5/2/2024
+* 05-02-24
+* 05-02-2024
+* 5-2-24
+* 5-2-2024
+
+Example:
+
+findDates("I have a dentist appointment on 11/14/2023 and book club on 12-1-23")
+
+Returns: ["11/14/2023", "12-1-23"]
+```
 
 Unit tests can also serve as examples. Before writing your function, you can use {% data variables.product.prodname_copilot_short %} to write unit tests for the function. Then, you can ask {% data variables.product.prodname_copilot_short %} to write a function described by those unit tests.
 

content/copilot/get-started/quickstart.md

@@ -52,9 +52,9 @@ To use {% data variables.product.prodname_copilot_short %} on the {% data variab
 
    For example, you could enter:
 
-   * Explain this file.
-   * How could I improve this code?
-   * How can I test this code?
+   * `Explain this file.`
+   * `How could I improve this code?`
+   * `How can I test this code?`
 
    {% data variables.product.prodname_copilot_short %} responds to your request in the panel.
 

content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md

@@ -434,7 +434,7 @@ To configure the remote {% data variables.product.github %} MCP server with a PA
     }
   }
 ```
-  
+
 ## Using the {% data variables.product.github %} MCP server in Xcode
 
 The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in Xcode.
@@ -546,8 +546,12 @@ The {% data variables.product.github %} MCP server is automatically configured i
 1. In the prompt box, type a request related to the skill you want {% data variables.copilot.copilot_chat_short %} to perform, and press **Enter**.
 
     Some examples of requests you can make are:
-    * `Create a new branch called [BRANCH-NAME] in the repository [USERNAME/REPO-NAME].`
-    * `Merge the pull request [PULL-REQUEST-NUMBER] in the repository [USERNAME/REPO-NAME].`
+
+    {% prompt %}Create a new branch called [BRANCH-NAME] in the repository [OWNER/REPO-NAME].{% endprompt %}
+
+    {% prompt %}Search for users with the name [USER-NAME]{% endprompt %}
+
+    {% prompt %}Merge the pull request [PR-NUMBER] in the repository [OWNER/REPO-NAME].{% endprompt %}
 
 1. {% data variables.copilot.copilot_chat_short %} will ask you to confirm that you want to proceed with the action. Click **Allow** to confirm.
 1. {% data variables.copilot.copilot_chat_short %} will use the relevant skill from the {% data variables.product.github %} MCP server to perform the action you requested. {% data variables.copilot.copilot_chat_short %} will show you the result of the action in the chat interface.

content/copilot/how-tos/use-chat/get-started-with-chat.md

@@ -251,9 +251,9 @@ Some of the example prompts require you to be in a specific context on the {% da
 
 You can ask {% data variables.copilot.copilot_chat_short %} general software questions. For example:
 
-* `tell me about nodejs web server frameworks`
-* `how can I create an Express app`
-* `what is the best way to update an npm package`
+* {% prompt %}tell me about nodejs web server frameworks{% endprompt %}
+* {% prompt %}how can I create an Express app{% endprompt %}
+* {% prompt %}what is the best way to update an npm package{% endprompt %}
 
 ## Ask questions about a repository
 

content/copilot/how-tos/use-chat/use-chat-in-github.md

@@ -35,11 +35,11 @@ Depending on the question you ask, and your enterprise and organization settings
 
    Some examples of general questions you could ask are:
 
-   * `What are the advantages of the Go programming language?`
-   * `What is Agile software development?`
-   * `What is the most popular JavaScript framework?`
-   * `Give me some examples of regular expressions.`
-   * `Write a bash script to output today's date.`
+   * {% prompt %}What are the advantages of the Go programming language?{% endprompt %}
+   * {% prompt %}What is Agile software development?{% endprompt %}
+   * {% prompt %}What is the most popular JavaScript framework?{% endprompt %}
+   * {% prompt %}Give me some examples of regular expressions.{% endprompt %}
+   * {% prompt %}Write a bash script to output today's date.{% endprompt %}
 
 {% data reusables.copilot.stop-response-generation %}
 1. If {% data variables.product.prodname_copilot_short %} uses a Bing search to answer your question, you can click the **_n_ references** link at the top of the response to see the search results that {% data variables.product.prodname_copilot_short %} used to answer your question.
@@ -59,7 +59,7 @@ Depending on the question you ask, and your enterprise and organization settings
 
 When you ask a question, {% data variables.product.prodname_copilot_short %} may generate one or more files as part of its response. In the {% data variables.copilot.copilot_chat_short %} panel, the files are displayed inline, within the chat response. In immersive view (that is, at [https://github.com/copilot](https://github.com/copilot)), the generated files are displayed in a side panel. You can view and edit the files in the panel, or download them to your computer.
 
-For example, asking `Generate a simple calculator using HTML, CSS, and JavaScript` may generate multiple files, such as `index.html`, `styles.css`, and `script.js`.
+For example, asking {% prompt %}Generate a simple calculator using HTML, CSS, and JavaScript{% endprompt %} may generate multiple files, such as `index.html`, `styles.css`, and `script.js`.
 
 In immersive view, you can also preview how some file formats, such as Markdown, render by toggling to the "Preview" tab in the side panel.
 
@@ -118,9 +118,9 @@ To navigate between subthreads:
 
 {% data variables.product.prodname_copilot_short %} has access to a collection of skills to fetch data from {% data variables.product.github %}, which are dynamically selected based on the question you ask.
 
-You can explicitly ask {% data variables.copilot.copilot_chat_dotcom %} to use a particular skill - for example, `Use the Bing skill to find the latest GPT4 model from OpenAI`.
+You can explicitly ask {% data variables.copilot.copilot_chat_dotcom %} to use a particular skill - for example, {% prompt %}Use the Bing skill to find the latest GPT4 model from OpenAI.{% endprompt %}
 
-Generate a list of currently available skills by asking {% data variables.product.prodname_copilot_short %}: `What skills are available?`
+Generate a list of currently available skills by asking {% data variables.product.prodname_copilot_short %}: {% prompt %}What skills are available?{% endprompt %}
 
 ## Asking {% data variables.copilot.copilot_chat_short %} questions in different contexts
 
@@ -171,9 +171,9 @@ You can ask {% data variables.product.prodname_copilot_short %} a question about
 
    For example, you could enter:
 
-   * What does this repo do?
-   * Where is authentication implemented in this codebase?
-   * How does license file detection work in this repo?
+   * `What does this repo do?`
+   * `Where is authentication implemented in this codebase?`
+   * `How does license file detection work in this repo?`
 
 1. Click **Ask {% data variables.product.prodname_copilot_short %}**.
 

content/copilot/how-tos/use-chat/use-chat-in-mobile.md

@@ -63,11 +63,11 @@ You can ask a general question about software development{% ifversion ghec %} th
 1. At the bottom of the page, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and send the message.
 
    Some examples of general questions you could ask are:
-   * What are the advantages of the Go programming language?
-   * What is Agile software development?
-   * What is the most popular JavaScript framework?
-   * Give me some examples of regular expressions.
-   * Write a bash script to output today's date.
+   * `What are the advantages of the Go programming language?`
+   * `What is Agile software development?`
+   * `What is the most popular JavaScript framework?`
+   * `Give me some examples of regular expressions.`
+   * `Write a bash script to output today's date.`
 
 1. Within a conversation thread, you can ask follow-up questions. {% data variables.product.prodname_copilot_short %} will answer within the context of the conversation. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment.
 
@@ -84,11 +84,11 @@ You can ask questions about a specific repository, to get help with understandin
 
    For example, if you chose the repository you are working in as the context, you could ask:
 
-   * What is the main purpose of this repo? What problem does it solve or what functionality does it provide?
-   * What web frameworks are used in this project?
-   * Where is rate limiting implemented in our API?
-   * How is the code organized? Explain the project architecture.
-   * Are there any specific environment requirements for working on this project?
+   * `What is the main purpose of this repo? What problem does it solve or what functionality does it provide?`
+   * `What web frameworks are used in this project?`
+   * `Where is rate limiting implemented in our API?`
+   * `How is the code organized? Explain the project architecture.`
+   * `Are there any specific environment requirements for working on this project?`
 
    > [!IMPORTANT]
    > {% data variables.product.prodname_copilot_short %}'s ability to answer natural language questions like these in a repository context is improved when the repository has been indexed for semantic code search. Without indexing, {% data variables.copilot.copilot_mobile_short %} may not be able to provide the most relevant answers to your questions.
@@ -110,15 +110,15 @@ You can chat with {% data variables.product.prodname_copilot_short %} about a fi
 
    For example, if you are asking about the entire file, you could enter:
 
-   * Explain this file.
-   * How could I improve this code?
-   * How can I test this script?
+   * `Explain this file.`
+   * `How could I improve this code?`
+   * `How can I test this script?`
 
    If you are asking about specific lines, you could enter:
 
-   * How could I improve this class?
-   * Add error handling to this code.
-   * Write a unit test for this method.
+   * `How could I improve this class?`
+   * `Add error handling to this code.`
+   * `Write a unit test for this method.`
 
    {% data variables.product.prodname_copilot_short %} responds to your request in the panel.
 
@@ -135,10 +135,10 @@ You can ask questions about a specific pull request in a repository.
 
    For example, you could ask:
 
-   * What is the purpose of this pull request?
-   * What changes are being made in this pull request?
-   * Are there any potential issues with this pull request?
-   * What is the status of this pull request?
+   * `What is the purpose of this pull request?`
+   * `What changes are being made in this pull request?`
+   * `Are there any potential issues with this pull request?`
+   * `What is the status of this pull request?`
 
    {% data variables.product.prodname_copilot_short %} responds to your request in the panel.
 
@@ -153,10 +153,10 @@ You can ask questions about a specific issue in a repository.
 
    For example, you could ask:
 
-   * What is the purpose of this issue?
-   * What is the status of this issue?
-   * What are the steps to reproduce this issue?
-   * Are there any potential solutions to this issue?
+   * `What is the purpose of this issue?`
+   * `What is the status of this issue?`
+   * `What are the steps to reproduce this issue?`
+   * `Are there any potential solutions to this issue?`
 
    {% data variables.product.prodname_copilot_short %} responds to your request in the panel.
 
@@ -171,10 +171,10 @@ You can ask questions about a specific discussion in a repository.
 
    For example, you could ask:
 
-   * What is the purpose of this discussion?
-   * What are the main points of this discussion?
-   * What are the next steps for this discussion?
-   * Are there any potential issues with this discussion?
+   * `What is the purpose of this discussion?`
+   * `What are the main points of this discussion?`
+   * `What are the next steps for this discussion?`
+   * `Are there any potential issues with this discussion?`
 
    {% data variables.product.prodname_copilot_short %} responds to your request in the panel.