Skip to content

Commit ce9cbce

Browse files
Add reference links for improved navigation and clarity in project documentation
1 parent 2f1c8dd commit ce9cbce

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

content/1-hour/2-explore-project.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Helping GitHub Copilot understand context
22

3+
| [← Coding with GitHub Copilot][walkthrough-previous] | [Next: Providing custom instructions →][walkthrough-next] |
4+
|:-----------------------------------|------------------------------------------:|
5+
36
The key to success when coding (and much of life) is context. Before we add code to a codebase, we want to understand the rules and structures already in place. When working with an AI coding assistant such as GitHub Copilot the same concept applies - the quality of suggestion is directly proportional to the context Copilot has. Let's use this opportunity to both explore the project we've been given and how to interact with Copilot to ensure it has the context it needs to do its best work.
47

58
## Scenario
@@ -8,7 +11,7 @@ Before adding new functionality to the website, you want to explore the existing
811

912
## Chat participants and extensions
1013

11-
GitHub Copilot Chat has a set of available [chat participants](https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-participants) and [extensions](https://docs.github.com/en/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat) available to you to both provide instructions to GitHub Copilot and access external services. Chat participants are helpers which work inside your IDE and have access to your project, while extensions can call external services and provide information to you without having to open separate tools. We're going to focus on one core chat participant - `@workspace`.
14+
GitHub Copilot Chat has a set of available [chat participants][chat-participants] and [extensions][copilot-extensions] available to you to both provide instructions to GitHub Copilot and access external services. Chat participants are helpers which work inside your IDE and have access to your project, while extensions can call external services and provide information to you without having to open separate tools. We're going to focus on one core chat participant - `@workspace`.
1215

1316
`@workspace` creates an index of your project and allows you to ask questions about what you're currently working on, to find resources inside the project, or add it to the context. It's best to use this when the entirety of your project should be considered or you're not entirely sure where you should start looking. In our current scenario, since we want to ask questions about our project, `@workspace` is the perfect tool for the job.
1417

@@ -26,12 +29,21 @@ GitHub Copilot Chat has a set of available [chat participants](https://code.visu
2629

2730
## Summary and next steps
2831

29-
You've explored context in GitHub Copilot, which is key to generating quality suggestions. You saw how you can use chat participants to help guide GitHub Copilot, and how with natural language you can explore the project. Let's see how we can provide even more context to Copilot chat through the use of [Copilot instructions](./3-copilot-instructions.md).
32+
You've explored context in GitHub Copilot, which is key to generating quality suggestions. You saw how you can use chat participants to help guide GitHub Copilot, and how with natural language you can explore the project. Let's see how we can provide even more context to Copilot chat through the use of [Copilot instructions][copilot-instructions].
3033

3134
## Resources
3235

33-
- [Copilot Chat cookbook](https://docs.github.com/en/copilot/copilot-chat-cookbook)
34-
- [Use Copilot Chat in VS Code](https://code.visualstudio.com/docs/copilot/copilot-chat)
35-
- [Copilot extensions marketplace](https://github.com/marketplace?type=apps&copilot_app=true)
36+
- [Copilot Chat cookbook][copilot-cookbook]
37+
- [Use Copilot Chat in VS Code][copilot-chat-vscode]
38+
- [Copilot extensions marketplace][copilot-marketplace]
39+
40+
| [← Coding with GitHub Copilot][walkthrough-previous] | [Next: Providing custom instructions →][walkthrough-next] |
41+
|:-----------------------------------|------------------------------------------:|
3642

37-
**NEXT:** [Add Copilot instructions for additional context](./3-copilot-instructions.md)
43+
[chat-participants]: https://code.visualstudio.com/docs/copilot/copilot-chat#_chat-participants
44+
[copilot-chat-vscode]: https://code.visualstudio.com/docs/copilot/copilot-chat
45+
[copilot-cookbook]: https://docs.github.com/en/copilot/copilot-chat-cookbook
46+
[copilot-extensions]: https://docs.github.com/en/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat
47+
[copilot-marketplace]: https://github.com/marketplace?type=apps&copilot_app=true
48+
[walkthrough-previous]: ./1-add-endpoint.md
49+
[walkthrough-next]: ./3-copilot-instructions.md

0 commit comments

Comments
 (0)