-
Notifications
You must be signed in to change notification settings - Fork 60.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Copilot Chat for GitHub Mobile - [GA] (#49051)
Co-authored-by: Imen Mahjoubi <[email protected]> Co-authored-by: Ru Levin <[email protected]>
- Loading branch information
3 people
authored
May 7, 2024
1 parent
75fa744
commit 0ecb376
Showing
19 changed files
with
351 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
content/copilot/github-copilot-chat/about-github-copilot-chat-in-github-mobile.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: About GitHub Copilot Chat in GitHub Mobile | ||
| intro: '{% data variables.product.prodname_copilot_chat %} can help you by providing answers to coding related questions directly within {% data variables.product.prodname_mobile %}.' | ||
| redirect_from: | ||
| - /early-access/copilot/about-github-copilot-chat-in-github-mobile | ||
| versions: | ||
| feature: copilot-chat-for-mobile | ||
| topics: | ||
| - Copilot | ||
| - Mobile | ||
| shortTitle: About Copilot Chat (Mobile) | ||
| type: rai | ||
| --- | ||
|
|
||
| ## About {% data variables.product.prodname_copilot_mobile %} | ||
|
|
||
| {% data variables.product.prodname_copilot_mobile %} is a chat interface that lets you interact with {% data variables.product.prodname_copilot %}, to ask and receive answers to coding-related questions within {% data variables.product.prodname_mobile %}. The chat interface provides access to coding information and support without requiring you to navigate documentation or search online forums. In addition to {% data variables.product.prodname_mobile %}, {% data variables.product.prodname_copilot_chat_short %} is currently supported in {% data variables.product.prodname_dotcom_the_website %}, {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and the JetBrains suite of IDEs. For more information about {% data variables.product.prodname_copilot %}, see "[AUTOTITLE](/copilot/overview-of-github-copilot/about-github-copilot-individual)," "[AUTOTITLE](/copilot/overview-of-github-copilot/about-github-copilot-business)," and "[AUTOTITLE](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)." | ||
|
|
||
| {% data variables.product.prodname_copilot_chat %} can answer a wide range of coding-related questions on topics including syntax, programming concepts, test cases, debugging, and more. {% data variables.product.prodname_copilot_chat %} is not designed to answer non-coding questions or provide general information on topics outside of coding. | ||
|
|
||
| The primary supported language for {% data variables.product.prodname_copilot_mobile %} is English. | ||
|
|
||
| {% data variables.product.prodname_copilot_chat %} works by using a combination of natural language processing and machine learning to understand your question and provide you with an answer. This process can be broken down into a number of steps. | ||
|
|
||
| {% data reusables.rai.copilot.about-copilot-chat-in-mobile %} | ||
|
|
||
| ## Further reading | ||
|
|
||
| - "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" | ||
| - [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
...t/copilot/github-copilot-chat/enabling-github-copilot-chat-for-github-mobile.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| title: Enabling GitHub Copilot Chat for GitHub Mobile | ||
| intro: 'You can enable or disable {% data variables.product.prodname_copilot_chat %} for your organization{% ifversion ghec %} or enterprise{% endif %}.' | ||
| topics: | ||
| - Copilot | ||
| - Mobile | ||
| versions: | ||
| feature: copilot-chat-for-mobile | ||
| shortTitle: Enabling Copilot Chat (Mobile) | ||
| --- | ||
|
|
||
| If you have a {% data variables.product.prodname_copilot_for_individuals %} subscription, {% data variables.product.prodname_copilot_mobile %} is already enabled. | ||
|
|
||
| If you are part of an organization{% ifversion ghec %} or enterprise{% endif %} with a {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise %}{% endif %} subscription, the organization{% ifversion ghec %} or enterprise{% endif %} owner will need to enable {% data variables.product.prodname_copilot_chat %} in the {% data variables.product.prodname_copilot_short %} settings. | ||
|
|
||
| ## Enabling or disabling {% data variables.product.prodname_copilot_mobile_short %} at the organization level | ||
|
|
||
| An organization owner can enable or disable {% data variables.product.prodname_copilot_mobile_short %} for the organization. {% ifversion ghec %}You may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level.{% endif %} If your organization has a {% data variables.product.prodname_copilot_for_business %} subscription, {% data variables.product.prodname_copilot_mobile_short %} is disabled by default. | ||
|
|
||
| {% data reusables.profile.access_org %} | ||
| {% data reusables.profile.org_settings %} | ||
| {% data reusables.copilot.policy-settings %} | ||
| 1. To the right of "{% data variables.product.prodname_copilot_mobile_short %}", select the dropdown menu, then click **Enabled** or **Disabled**. | ||
|
|
||
| {% ifversion ghec %} | ||
|
|
||
| ## Enabling or disabling {% data variables.product.prodname_copilot_mobile_short %} at the enterprise level | ||
|
|
||
| An enterprise owner can choose whether to enable a feature for all organizations, disable for all organizations, or allow each organization to choose its own policy for the feature. | ||
|
|
||
| {% data reusables.copilot.copilot-chat-mobile-enable %} | ||
|
|
||
| {% endif %} | ||
|
|
||
| ## Next steps | ||
|
|
||
| You successfully enabled {% data variables.product.prodname_copilot_mobile_short %} for your organization{% ifversion ghec %} or enterprise{% endif %}. To learn more about how to use it, see "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-github-mobile)." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 128 additions & 0 deletions
128
content/copilot/github-copilot-chat/using-github-copilot-chat-in-github-mobile.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| --- | ||
| title: Using GitHub Copilot Chat in GitHub Mobile | ||
| intro: 'You can use {% data variables.product.prodname_copilot_mobile %} to answer general questions about software development{% ifversion ghec %}, or specific questions about the code in a repository{% endif %}.' | ||
| topics: | ||
| - Copilot | ||
| - Mobile | ||
| versions: | ||
| feature: copilot-chat-for-mobile | ||
| shortTitle: Use Copilot Chat (Mobile) | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| {% data variables.product.prodname_copilot_chat %} is a chat interface that lets you ask and receive answers to coding-related questions in {% data variables.product.prodname_mobile %}. You can also use {% data variables.product.prodname_copilot_chat %} {% ifversion ghec %}on either {% data variables.product.prodname_dotcom_the_website %} or{% endif %} within a supported IDE. For information on using {% data variables.product.prodname_copilot_chat %} in an IDE, see "[AUTOTITLE](/copilot/github-copilot-chat/using-github-copilot-chat-in-your-ide)." | ||
|
|
||
| {% data variables.product.prodname_copilot_mobile_short %} can help you with a variety of coding-related tasks, like offering you code suggestions, providing natural language descriptions of a piece of code's functionality and purpose, generating unit tests for your code, and proposing fixes for bugs in your code. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/about-github-copilot-chat-in-github-mobile)." | ||
|
|
||
| {% ifversion ghec %} | ||
| In {% data variables.product.prodname_mobile %}, you can use {% data variables.product.prodname_copilot_chat_short %} to ask: | ||
|
|
||
| - 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)." | ||
| - Questions asked in the context of your project. For more information, see "[Asking questions about a specific repository](#asking-exploratory-questions-about-a-repository)." | ||
| - 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)."{% endif %} | ||
|
|
||
| ## Limitations | ||
|
|
||
| The following {% ifversion fpt%}limitation applies{% else %} limitations apply{% endif %} to {% data variables.product.prodname_copilot_mobile_short %}: | ||
|
|
||
| {% ifversion ghec%} | ||
| - Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Anyone who gets access to {% data variables.product.prodname_copilot_short %} from the organization that owns a repository can index that repository.{% endif %} | ||
| - The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To use {% data variables.product.prodname_copilot_mobile_short %} you will need the following. | ||
|
|
||
| - **Subscription to {% data variables.product.prodname_copilot %}**: You must have an active {% data variables.product.prodname_copilot %} subscription. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." | ||
|
|
||
| If you do not have a {% data variables.product.prodname_copilot %} subscription, you can purchase a {% data variables.product.prodname_copilot_individuals_short %} subscription directly in the iOS version of {% data variables.product.prodname_mobile %}, or in the Google Play Store for the Android version of {% data variables.product.prodname_mobile %}. | ||
|
|
||
| - **Access to {% data variables.product.prodname_copilot_mobile_short %}**: If you are part of an organization{% ifversion ghec %} or enterprise{% endif %} with a {% data variables.product.prodname_copilot_for_business %}{% ifversion ghec %} or {% data variables.product.prodname_copilot_enterprise %}{% endif %} subscription, the organization{% ifversion ghec %} or enterprise{% endif %} owner will need to grant you access to {% data variables.product.prodname_copilot_cli_short %}. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/enabling-github-copilot-chat-for-github-mobile)." | ||
| - **Enable {% data variables.product.prodname_copilot_short %} features for your device**: {% data variables.product.prodname_copilot_short %} needs to be enabled from within {% data variables.product.prodname_mobile %}. For more information, see "[AUTOTITLE](/copilot/using-github-copilot/getting-started-with-github-copilot#enabling-or-disabling-copilot-in-github-mobile)." | ||
|
|
||
| ## Asking a general question about software development | ||
|
|
||
| You can ask a general question about software development{% ifversion ghec %} that is not focused on a particular context, such as a repository{% endif %}. | ||
|
|
||
| 1. In {% data variables.product.prodname_mobile %}, tap the **{% octicon "copilot" aria-hidden="true" %}** {% data variables.product.prodname_copilot %} icon in the bottom right corner of the screen. | ||
|
|
||
| > [!NOTE] | ||
| > The **{% octicon "copilot" aria-hidden="true" %}** {% data variables.product.prodname_copilot %} icon is not shown on every page in {% data variables.product.prodname_mobile %}. If you don't see the icon, navigate to a different page in {% data variables.product.prodname_mobile %} and look for the icon there. | ||
| 1. If the page displays a previous conversation you had with {% data variables.product.prodname_copilot_short %}, tap {% octicon "kebab-horizontal" %} in the top right corner of the screen, and then tap **New conversation {% octicon "plus" aria-hidden="true" %}**. | ||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| You can use your initial question as a foundation for follow-up questions. A detailed foundational prompt can help {% data variables.product.prodname_copilot_short %} provide more relevant answers to your follow-up questions. For more information, see "[Prompting {% data variables.product.prodname_copilot_chat %} to become your personal AI assistant for accessibility](https://github.blog/2023-10-09-prompting-github-copilot-chat-to-become-your-personal-ai-assistant-for-accessibility/)" on the {% data variables.product.prodname_dotcom %} Blog. | ||
|
|
||
| {% data reusables.copilot.chat-mobile-conversation-buttons %} | ||
|
|
||
| {% ifversion ghec %} | ||
|
|
||
| ## Asking exploratory questions about a repository | ||
|
|
||
| You can ask questions about a specific repository, to get help with understanding the code, or to get help with a specific task you're working on. | ||
|
|
||
| 1. In {% data variables.product.prodname_mobile %}, navigate to a repository, and tap the **{% octicon "copilot" aria-hidden="true" %}** {% data variables.product.prodname_copilot %} icon in the bottom right corner of the screen. | ||
| 1. At the bottom of the page, use the "Ask {% data variables.product.prodname_copilot_short %}" box, type a question and send the message. | ||
|
|
||
| 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? | ||
|
|
||
| > [!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. However, only members of an enterprise with a {% data variables.product.prodname_copilot_enterprise %} subscription can index a repository for semantic code search. Without indexing, {% data variables.product.prodname_copilot_mobile_short %} may not be able to provide the most relevant answers to your questions. | ||
| > | ||
| > Additionally, indexing a repository is not possible in {% data variables.product.prodname_mobile %}. To index a repository, you must use {% data variables.product.prodname_copilot_chat_short %} in a web browser. For more information, see step 6 of "[Asking a question about a specific repository, file or symbol](/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)." | ||
| {% data reusables.copilot.chat-mobile-conversation-buttons %} | ||
|
|
||
| ## Asking questions about specific pieces of code | ||
|
|
||
| You can chat with {% data variables.product.prodname_copilot_short %} about a file in your repository, or about specific lines of code within a file. | ||
|
|
||
| 1. In {% data variables.product.prodname_mobile %}, navigate to a repository and open a file. | ||
| 1. Do one of the following: | ||
| - To ask a question about the entire file, tap the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) in the bottom right corner of the file view. | ||
| - To ask a question about specific lines within the file, select and copy the lines you want to ask about. Then tap the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" %}) and paste the copied lines in the {% data variables.product.prodname_copilot_chat_short %} input field. | ||
|
|
||
| 1. Type a question in the "Ask {% data variables.product.prodname_copilot_short %}" box at the bottom of the chat panel and send the message. | ||
|
|
||
| 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? | ||
|
|
||
| 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. | ||
|
|
||
| {% data variables.product.prodname_copilot_short %} responds to your request in the panel. | ||
|
|
||
| 1. You can continue the conversation by asking a follow-up question. For example, you could type "tell me more" to get {% data variables.product.prodname_copilot_short %} to expand on its last comment. | ||
|
|
||
| {% endif %} | ||
|
|
||
| ## Sharing feedback about {% data variables.product.prodname_copilot_mobile %} | ||
|
|
||
| To give feedback about a particular {% data variables.product.prodname_copilot_chat_short %} response: | ||
|
|
||
| 1. Tap the ellipsis (**...**) in the top right corner above the chat response you want to provide feedback on, and tap either **Like {% data variables.product.prodname_copilot_short %} response {% octicon "thumbsup" aria-label="The thumbs up icon" %}** or **Dislike {% data variables.product.prodname_copilot_short %} response {% octicon "thumbsdown" aria-label="The thumbs down icon" %}**, | ||
| 1. Optionally, provide information about why you liked or disliked the response. | ||
| 1. Tap **Submit**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.