Skip to content

Commit 60a6422

Browse files
authored
Merge pull request #9550 from microsoft/ntrogh/redirect-prompt-engineering-guide
Redirect prompt engineering guide
2 parents e2edc0f + 7c37076 commit 60a6422

7 files changed

Lines changed: 7 additions & 13 deletions

File tree

build/sitemap.xml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -465,11 +465,6 @@
465465
<changefreq>weekly</changefreq>
466466
<priority>0.8</priority>
467467
</url>
468-
<url>
469-
<loc>https://code.visualstudio.com/docs/copilot/guides/prompt-engineering-guide</loc>
470-
<changefreq>weekly</changefreq>
471-
<priority>0.8</priority>
472-
</url>
473468
<url>
474469
<loc>https://code.visualstudio.com/docs/copilot/guides/test-driven-development-guide</loc>
475470
<changefreq>weekly</changefreq>

docs/copilot/best-practices.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The quality of AI responses depends on the clarity and specificity of your promp
8484
8585
* **Parallel tasks.** If you have multiple independent tasks, ask the AI to run them in parallel to save time. For example, "Perform isolated research about X and Y in parallel and summarize the findings."
8686
87-
For more information, see [prompt engineering](/docs/copilot/guides/prompt-engineering-guide.md) and find practical [prompt examples](https://docs.github.com/en/copilot/copilot-chat-cookbook) in the GitHub Copilot documentation.
87+
For more information, find practical [prompt examples](https://docs.github.com/en/copilot/copilot-chat-cookbook) in the GitHub Copilot documentation.
8888
8989
## Provide the right context
9090
@@ -177,7 +177,6 @@ For more information, see [workspace context](/docs/copilot/reference/workspace-
177177
178178
## Related resources
179179
180-
* [Prompt engineering guide](/docs/copilot/guides/prompt-engineering-guide.md)
181180
* [Context engineering guide](/docs/copilot/guides/context-engineering-guide.md)
182181
* [Customization overview](/docs/copilot/customization/overview.md)
183182
* [Cheat sheet](/docs/copilot/reference/copilot-vscode-features.md)

docs/copilot/chat/copilot-chat-context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,5 +185,5 @@ If you want to reset the context entirely, start a [new chat session](/docs/copi
185185

186186
* [Chat overview](/docs/copilot/chat/copilot-chat.md)
187187
* [Prompt examples](/docs/copilot/chat/prompt-examples.md)
188-
* [Prompt engineering guide](/docs/copilot/guides/prompt-engineering-guide.md)
188+
* [Prompt engineering guide](/docs/copilot/best-practices.md)
189189
* [Debug chat interactions](/docs/copilot/chat/chat-debug-view.md)

docs/copilot/chat/copilot-chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ After the AI makes changes to your files, review and accept or discard them.
158158
159159
Chat provides several ways to improve the quality and relevance of AI responses:
160160
161-
* **Write effective prompts**: be specific about what you want, reference relevant files and symbols, and use `/` commands for common tasks. Get inspired by [prompt examples](/docs/copilot/chat/prompt-examples.md) or review the full [prompt engineering guide](/docs/copilot/guides/prompt-engineering-guide.md).
161+
* **Write effective prompts**: be specific about what you want, reference relevant files and symbols, and use `/` commands for common tasks. Get inspired by [prompt examples](/docs/copilot/chat/prompt-examples.md) or review the full [prompt engineering guide](/docs/copilot/best-practices.md).
162162
163163
* **Customize the AI**: tailor the AI's behavior to your project by adding [custom instructions](/docs/copilot/customization/custom-instructions.md), creating reusable [prompt files](/docs/copilot/customization/prompt-files.md), or building [custom agents](/docs/copilot/customization/custom-agents.md) for specialized workflows. For example, create a "Code Reviewer" agent that provides feedback on code quality and adherence to your team's coding standards.
164164

docs/copilot/chat/prompt-examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ MetaSocialImage: ../images/shared/github-copilot-social.png
88

99
This article provides example prompts for chat in Visual Studio Code across different scenarios and agents. Use these examples as inspiration to craft effective prompts for your own development tasks.
1010

11-
If you are new to using chat in VS Code, learn more about [getting started with chat](/docs/copilot/chat/copilot-chat.md) or review [best practices for prompt crafting](/docs/copilot/guides/prompt-engineering-guide.md).
11+
If you are new to using chat in VS Code, learn more about [getting started with chat](/docs/copilot/chat/copilot-chat.md) or review [best practices for prompt crafting](/docs/copilot/best-practices.md).
1212

1313
<div class="docs-action" data-show-in-doc="false" data-show-in-sidebar="true" title="Get started with agents">
1414
Follow a hands-on tutorial to experience local, background, and cloud agents in VS Code.
@@ -186,7 +186,7 @@ By building on earlier responses, the AI maintains context from the previous ste
186186
* **Iterate**: Start with a simple prompt and refine it based on the response. Ask follow-up questions to improve the results.
187187
* **Break down complex tasks**: Instead of asking for everything at once, break large tasks into smaller, manageable steps.
188188

189-
Learn more about [best practices for crafting prompts](/docs/copilot/guides/prompt-engineering-guide.md) and [adding context to your prompts](/docs/copilot/chat/copilot-chat-context.md).
189+
Learn more about [best practices for crafting prompts](/docs/copilot/best-practices.md) and [adding context to your prompts](/docs/copilot/chat/copilot-chat-context.md).
190190

191191
## Related resources
192192

docs/redirection.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
{ "from": "/docs/copilot/agents/background-agents", "to": "/docs/copilot/agents/copilot-cli", "status": 301 },
44
{ "from": "/docs/copilot/setup-simplified", "to": "/docs/copilot/setup", "status": 301 },
55
{ "from": "/docs/copilot/copilot-tips-and-tricks", "to": "/docs/copilot/best-practices", "status": 301 },
6-
{ "from": "/docs/typescript/typescript-compiling", "to": "/docs/typescript/typescript-transpiling", "status": 301 }
6+
{ "from": "/docs/typescript/typescript-compiling", "to": "/docs/typescript/typescript-transpiling", "status": 301 },
7+
{ "from": "/docs/copilot/guides/prompt-engineering-guide", "to": "/docs/copilot/best-practices", "status": 301 }
78
]

docs/toc.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,6 @@
107107
"area": "copilot/guides",
108108
"noCollapse": false,
109109
"topics": [
110-
["Prompt Engineering", "/docs/copilot/guides/prompt-engineering-guide"],
111110
["Context Engineering", "/docs/copilot/guides/context-engineering-guide"],
112111
["Customize AI", "/docs/copilot/guides/customize-copilot-guide"],
113112
["Test-Driven Development", "/docs/copilot/guides/test-driven-development-guide"],

0 commit comments

Comments
 (0)