Skip to content

Commit ecbd384

Browse files
arfontimrogershubwritergithub-actions
authored
Breaking out exploratory questions section (#49693)
Co-authored-by: Tim Rogers <[email protected]> Co-authored-by: hubwriter <[email protected]> Co-authored-by: github-actions <[email protected]>
1 parent 107485b commit ecbd384

File tree

4 files changed

+48
-31
lines changed

4 files changed

+48
-31
lines changed
Loading
8.79 KB
Loading

content/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md

+39-31
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ topics:
2323
On {% data variables.product.prodname_dotcom_the_website %}, you can use {% data variables.product.prodname_copilot_chat_short %} to ask:
2424

2525
- General software-related questions, without a particular context. For more information, see "[Asking a general question about software development](#asking-a-general-question-about-software-development)."
26-
- Questions asked in the context of a specific repository, file or symbol. For more information, see "[Asking a question about a specific repository, file or symbol](#asking-a-question-about-a-specific-repository-file-or-symbol)."
26+
- Exploratory questions asked in the context of a specific repository. For more information, see "[Asking exploratory questions about a repository](#asking-exploratory-questions-about-a-repository)."
27+
- Questions asked in the context of a specific repository, file or symbol. For more information, see "[Asking a question about a specific file or symbol](#asking-a-question-about-a-specific-file-or-symbol)."
2728
- Questions asked in the context of a knowledge base (that is, Markdown documentation across one or more repositories). For more information, see "[Asking a question about a knowledge base](#asking-a-question-about-a-knowledge-base)."
2829
- Questions about a specific file or specified lines of code within a file. For more information, see "[Asking questions about specific pieces of code](#asking-questions-about-specific-pieces-of-code)."
2930
- Questions about a pull request diff. For more information, see "[Finding out about the changes in a pull request](#finding-out-about-the-changes-in-a-pull-request)."
@@ -52,9 +53,13 @@ Depending on the question you ask, and your enterprise and organization settings
5253

5354
{% data reusables.copilot.go-to-copilot-page %}
5455

56+
1. If the panel is headed "Chatting about OWNER/REPOSITORY," click **All repositories**.
57+
58+
![Screenshot of the {% data variables.product.prodname_copilot_short %} chat panel page with "All repositories" highlighted with a dark orange outline.](/assets/images/help/copilot/copilot-chat-all-repositories.png)
59+
5560
1. If the "Ask {% data variables.product.prodname_copilot_short %}" page is displayed in the panel, click **General purpose chat**.
5661

57-
![Screenshot of the "Ask {% data variables.product.prodname_copilot_short %}" panel page with "General purpose chat" highlighted with a dark orange outline.](/assets/images/help/copilot/chat-general-purpose-button.png)
62+
![Screenshot of the {% data variables.product.prodname_copilot_short %} chat panel with "General purpose chat" highlighted with a dark orange outline.](/assets/images/help/copilot/chat-general-purpose-button.png)
5863

5964
1. At the bottom of the panel, in the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
6065

@@ -72,61 +77,60 @@ Depending on the question you ask, and your enterprise and organization settings
7277

7378
{% data reusables.copilot.chat-conversation-buttons %}
7479

75-
## Asking a question about a specific repository, file or symbol
80+
## Asking exploratory questions about a repository
7681

77-
You can choose a particular repository, file or symbol, and then ask a question with that context in mind.
78-
79-
{% note %}
80-
81-
**Note:** A "symbol" is a named entity in code. This could be a variable, function, class, module, or any other identifier that's part of a codebase.
82-
83-
{% endnote %}
82+
{% data variables.product.prodname_copilot_short %} allows you to use natural language questions to explore repositories on {% data variables.product.prodname_dotcom %}. This can help you get a better understanding of where specific aspects of a codebase are implemented.
8483

8584
{% data reusables.copilot.go-to-copilot-page %}
86-
1. If the "Ask {% data variables.product.prodname_copilot_short %}" page is not displayed in the panel, click **All topics**.
8785

88-
![Screenshot of the "All topics" link at the top of the chat panel, highlighted with a dark orange outline.](/assets/images/help/copilot/chat-all-topics-button.png)
86+
{% data reusables.copilot.ask-copilot-not-displayed %}
87+
88+
{% note %}
8989

90-
1. On the "Ask {% data variables.product.prodname_copilot_short %}" page, select a repository to provide a context for your question.
90+
**Note**:
9191

92-
For example, you could choose a repository whose code you want to understand better.
92+
{% 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. The indexing status of the repository is displayed when you start a conversation that has a repository context.
9393

94-
You can search for a repository if you don't see one you want to use.
94+
If you get access to {% data variables.product.prodname_copilot_short %} from the organization that owns the repository, and the repository has not been indexed, an **Index REPOSITORY NAME** button is displayed. Click this button to start the indexing process.
9595

96-
1. Optionally, after selecting a repository, if you want to set particular files or symbols from the selected repository as your context, click the "Attach files or symbols" button (a paperclip icon) at the bottom of the chat panel, then search for and select one or more files and symbols.
96+
![Screenshot showing the 'Index REPOSITORY NAME' button highlighted with a dark orange outline.](/assets/images/help/copilot/index-this-repo.png)
9797

98-
![Screenshot of the "Attach files or symbols" button, highlighted with a dark orange outline.](/assets/images/help/copilot/chat-paperclip-icon.png)
98+
{% endnote %}
9999

100100
1. In the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
101101

102102
For example, you could ask:
103103

104-
- What is the main purpose of this repo? What problem does it solve or what functionality does it provide?
105-
- What web frameworks are used in this project?
106104
- Where is rate limiting implemented in our API?
107105
- How does the WidgetFactory class work?
108-
- How is the code organized? Explain the project architecture.
109-
- Are there any specific environment requirements for working on this project?
106+
- Where is the code for converting an organization member to be an outside collaborator?
107+
- Where are SAT tokens generated?
110108

111-
{% note %}
109+
{% data variables.product.prodname_copilot_short %} replies in the chat panel.
112110

113-
**Note**:
111+
{% data reusables.copilot.chat-conversation-buttons %}
114112

115-
{% 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. The indexing status of the repository is displayed when you start a conversation that has a repository context.
113+
## Asking a question about a specific file or symbol
116114

117-
If you get access to {% data variables.product.prodname_copilot_short %} from the organization that owns the repository, and the repository has not been indexed, an **Index REPOSITORY NAME** button is displayed. Click this button to start the indexing process.
115+
You can ask {% data variables.product.prodname_copilot_short %} about a specific file or symbol within a repository.
118116

119-
![Screenshot showing the 'Index REPOSITORY NAME' button highlighted with a dark orange outline.](/assets/images/help/copilot/index-this-repo.png)
117+
{% note %}
120118

121-
{% endnote %}
119+
**Note:** A "symbol" is a named entity in code. This could be a variable, function, class, module, or any other identifier that's part of a codebase.
122120

123-
1. The response typically contains numbered references to files that {% data variables.product.prodname_copilot_short %} used to generate the answer, from the repository you selected. To list the sources that were used, click **NUMBER references**.
121+
{% endnote %}
124122

125-
![Screenshot showing an expanded list of source references.](/assets/images/help/copilot/chat-sources-list.png)
123+
{% data reusables.copilot.go-to-copilot-page %}
126124

127-
1. To display a source reference in a popup, click its entry in the list.
125+
{% data reusables.copilot.ask-copilot-not-displayed %}
128126

129-
Alternatively, to open the complete file, click the ellipsis (**...**), then select **Open**.
127+
1. Click the "Attach files or symbols" button (a paperclip icon) at the bottom of the chat panel, then search for and select one or more files and symbols.
128+
129+
![Screenshot of the "Attach files or symbols" button, highlighted with a dark orange outline.](/assets/images/help/copilot/chat-paperclip-icon.png)
130+
131+
1. In the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and press <kbd>Enter</kbd>.
132+
133+
{% data variables.product.prodname_copilot_short %} replies in the chat panel.
130134

131135
{% data reusables.copilot.chat-conversation-buttons %}
132136

@@ -138,6 +142,10 @@ When you enter a query, {% data variables.product.prodname_copilot_short %} sear
138142

139143
{% data reusables.copilot.go-to-copilot-page %}
140144

145+
1. If the "Ask {% data variables.product.prodname_copilot_short %}" page is not displayed in the panel, click **All repositories**.
146+
147+
![Screenshot of the {% data variables.product.prodname_copilot_short %} chat panel page with "All repositories" highlighted with a dark orange outline.](/assets/images/help/copilot/copilot-chat-all-repositories.png)
148+
141149
1. Start a conversation with {% data variables.product.prodname_copilot_short %} by either selecting a repository or clicking **General purpose chat**.
142150
1. Click the "Attach knowledge" button (a book icon) at the bottom of the chat panel, to view a list of the knowledge bases that you have access to.
143151

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
1. If the "Ask {% data variables.product.prodname_copilot_short %}" page is not displayed in the panel, click **All repositories**.
2+
3+
![Screenshot of the {% data variables.product.prodname_copilot_short %} chat panel page with "All repositories" highlighted with a dark orange outline.](/assets/images/help/copilot/copilot-chat-all-repositories.png)
4+
5+
1. On the "Ask {% data variables.product.prodname_copilot_short %}" page, select a repository to provide a context for your question.
6+
7+
For example, you could choose a repository whose code you want to understand better.
8+
9+
You can search for a repository if you don't see one you want to use.

0 commit comments

Comments
 (0)