Docs updates for Spaces GA + Spaces in IDE (#57644)
Co-authored-by: hubwriter <hubwriter@github.com>
This commit is contained in:
Sarita Iyer
@@ -14,8 +14,6 @@ redirect_from:
|
||||
contentType: concepts
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-spaces.preview-note %}
|
||||
|
||||
{% data variables.copilot.copilot_spaces %} let you organize the context that {% data variables.product.prodname_copilot_short %} uses to answer your questions. {% data variables.copilot.copilot_spaces_short %} can include repositories, code, pull requests, issues, free-text content like transcripts or notes, images, and file uploads. You can ask {% data variables.product.prodname_copilot_short %} questions grounded in that context, or share the space with your team to support collaboration and knowledge sharing.
|
||||
|
||||
## Why use {% data variables.copilot.copilot_spaces %}?
|
||||
@@ -29,6 +27,8 @@ With {% data variables.copilot.copilot_spaces %} you can:
|
||||
* Reduce repeated questions by sharing knowledge with your team.
|
||||
* Support onboarding and reuse with self-service context that lives beyond chat history.
|
||||
|
||||
Your spaces stay in sync as your project evolves. {% data variables.product.github %} files and other {% data variables.product.github %}-based sources added to a space are automatically updated as they change, making {% data variables.product.prodname_copilot_short %} an evergreen expert in your project.
|
||||
|
||||
### How are {% data variables.copilot.copilot_spaces_short %} different from knowledge bases?
|
||||
|
||||
{% data variables.copilot.copilot_spaces_short %} are optimized for specific tasks and grounded conversations. Because context in {% data variables.copilot.copilot_spaces_short %} is scoped, {% data variables.product.prodname_copilot_short %}'s responses are more accurate and relevant.
|
||||
@@ -48,10 +48,12 @@ With {% data variables.copilot.copilot_spaces %} you can:
|
||||
|
||||
Anyone with a {% data variables.product.prodname_copilot_short %} license, including {% data variables.copilot.copilot_free_short %}, can create and use {% data variables.copilot.copilot_spaces_short %}.
|
||||
|
||||
During the {% data variables.release-phases.public_preview %}, if you're using a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, the organization or enterprise that provides your plan must have the **Opt in to preview features** setting enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) or [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom).
|
||||
|
||||
{% data variables.copilot.copilot_spaces_short %} can belong to a personal account or to an organization. Spaces owned by an organization can be shared with other organization members or kept private to the person who created the space.
|
||||
|
||||
## Where can I use {% data variables.copilot.copilot_spaces_short %}?
|
||||
|
||||
You can use {% data variables.copilot.copilot_spaces %} in {% data variables.copilot.copilot_chat_dotcom_short %}. You can also leverage {% data variables.copilot.copilot_spaces %} in your IDE, using the {% data variables.product.github %} MCP server in your IDE to access context from your spaces.
|
||||
|
||||
## How does using {% data variables.copilot.copilot_spaces_short %} affect my usage?
|
||||
|
||||
Questions you submit in a space count as {% data variables.copilot.copilot_chat_short %} requests.
|
||||
@@ -61,4 +63,4 @@ Questions you submit in a space count as {% data variables.copilot.copilot_chat_
|
||||
|
||||
## Next steps
|
||||
|
||||
To start using {% data variables.copilot.copilot_spaces_short %}, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/creating-and-using-copilot-spaces).
|
||||
To start using {% data variables.copilot.copilot_spaces_short %}, see [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/create-copilot-spaces).
|
||||
|
||||
@@ -63,7 +63,7 @@ Enhance {% data variables.copilot.copilot_chat_short %} responses by providing c
|
||||
|
||||
Automatically generate commit messages and descriptions with {% data variables.copilot.copilot_desktop_short %} based on the changes you make to your project.
|
||||
|
||||
### {% data variables.copilot.copilot_spaces %} ({% data variables.release-phases.public_preview %})
|
||||
### {% data variables.copilot.copilot_spaces %}
|
||||
|
||||
Organize and centralize relevant content—like code, docs, specs, and more—into {% data variables.copilot.copilot_spaces_short %} that ground {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task. See [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces).
|
||||
|
||||
|
||||
@@ -15,8 +15,6 @@ redirect_from:
|
||||
contentType: how-tos
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-spaces.preview-note %}
|
||||
|
||||
{% data variables.copilot.copilot_spaces %} let you organize the context that {% data variables.product.prodname_copilot_short %} uses to answer your questions. Sharing {% data variables.copilot.copilot_spaces %} helps your team:
|
||||
|
||||
* Avoid repeated explanations and handoffs.
|
||||
@@ -56,3 +54,5 @@ To share a space with others:
|
||||
## Accessing shared {% data variables.copilot.copilot_spaces_short %}
|
||||
|
||||
If you’re part of an organization that has shared spaces, you can access them in the **Organizations** tab on [https://github.com/copilot/spaces](https://github.com/copilot/spaces).
|
||||
|
||||
You can also access organization spaces directly in your IDE by specifying the organization as the owner when loading the space. For more information, see [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces#using-copilot-spaces-in-your-ide).
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
---
|
||||
title: Creating and using GitHub Copilot Spaces
|
||||
shortTitle: Create and use Copilot Spaces
|
||||
title: Creating GitHub Copilot Spaces
|
||||
shortTitle: Create Copilot Spaces
|
||||
intro: 'Create spaces to organize and centralize relevant content that grounds {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task.'
|
||||
permissions: 'Anyone with {% data variables.copilot.copilot_preview_features %} enabled can access {% data variables.copilot.copilot_spaces_short %}.'
|
||||
permissions: 'Anyone with a {% data variables.product.prodname_copilot_short %} license can use {% data variables.copilot.copilot_spaces_short %}.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/how-tos/provide-context/use-copilot-spaces/create-and-use-copilot-spaces
|
||||
- /copilot/using-github-copilot/copilot-spaces/creating-and-using-copilot-spaces
|
||||
- /copilot/how-tos/context/copilot-spaces/creating-and-using-copilot-spaces
|
||||
- /copilot/how-tos/context/copilot-spaces/create-and-use-copilot-spaces
|
||||
@@ -17,8 +18,6 @@ contentType: how-tos
|
||||
|
||||
For an overview of {% data variables.copilot.copilot_spaces %}, see [AUTOTITLE](/copilot/concepts/about-organizing-and-sharing-context-with-copilot-spaces).
|
||||
|
||||
{% data reusables.copilot.copilot-spaces.preview-note %}
|
||||
|
||||
## Creating a space
|
||||
|
||||
1. To create a space, go to [https://github.com/copilot/spaces](https://github.com/copilot/spaces), and click **Create space**.
|
||||
@@ -49,13 +48,8 @@ You can add two types of context to your space:
|
||||
* **{% octicon "upload" aria-hidden="true" aria-label="upload" %} Upload a file**: You can upload files directly from your local machine. This includes images, text files, rich documents, and spreadsheets.
|
||||
* **{% octicon "paste" aria-hidden="true" aria-label="paste" %} Add text content**: You can type or paste free-text content, such as transcripts, notes, or any other relevant information that can help {% data variables.product.prodname_copilot_short %} understand the context of your space.
|
||||
|
||||
## Using {% data variables.copilot.copilot_spaces %}
|
||||
|
||||
Once you've added context to your space, you can ask {% data variables.product.prodname_copilot_short %} questions in the chat interface. Your chat will be grounded in the context you've added.
|
||||
|
||||
You can also change the large language model (LLM) used for your space by selecting the **CURRENT-MODEL** {% octicon "chevron-down" aria-hidden="true" aria-label="chevron-down" %} dropdown menu, then clicking the AI model of your choice. For more information, see [AUTOTITLE](/copilot/reference/ai-models/model-comparison).
|
||||
|
||||
## Next steps
|
||||
|
||||
* To learn more about using {% data variables.copilot.copilot_spaces_short %} in {% data variables.product.github %} and your IDE, see [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/use-copilot-spaces).
|
||||
* To learn more about how to use {% data variables.copilot.copilot_spaces_short %} to help you with development work, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/speeding-up-development-work-with-copilot-spaces).
|
||||
* To learn how to share your space with your team, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces).
|
||||
@@ -7,7 +7,8 @@ versions:
|
||||
topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /create-and-use-copilot-spaces
|
||||
- /create-copilot-spaces
|
||||
- /use-copilot-spaces
|
||||
- /collaborate-with-your-team
|
||||
redirect_from:
|
||||
- /copilot/using-github-copilot/copilot-spaces
|
||||
@@ -15,3 +16,7 @@ redirect_from:
|
||||
- /copilot/how-tos/context/use-copilot-spaces
|
||||
contentType: how-tos
|
||||
---
|
||||
|
||||
These articles provide how-to information for creating and using {% data variables.copilot.copilot_spaces %}.
|
||||
|
||||
For an overview, see [AUTOTITLE](/copilot/concepts/context/spaces). To learn how to use {% data variables.copilot.copilot_spaces_short %} to help with development work, see [AUTOTITLE](/copilot/tutorials/speed-up-development-work).
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: Using GitHub Copilot Spaces
|
||||
shortTitle: Use Copilot Spaces
|
||||
intro: 'Use spaces to ground {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task.'
|
||||
permissions: 'Anyone with a {% data variables.product.prodname_copilot_short %} license can use {% data variables.copilot.copilot_spaces_short %}.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
contentType: how-tos
|
||||
---
|
||||
|
||||
For information on creating {% data variables.copilot.copilot_spaces %}, see [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/create-copilot-spaces).
|
||||
|
||||
## Using {% data variables.copilot.copilot_spaces %} in {% data variables.product.github %}
|
||||
|
||||
Once you've added context to your space, you can ask {% data variables.product.prodname_copilot_short %} questions in the chat interface in {% data variables.product.github %}. Your chat will be grounded in the context you've added.
|
||||
|
||||
You can also change the large language model (LLM) used for your space by selecting the **CURRENT-MODEL** {% octicon "chevron-down" aria-hidden="true" aria-label="chevron-down" %} dropdown menu, then clicking the AI model of your choice. For more information, see [AUTOTITLE](/copilot/reference/ai-models/model-comparison).
|
||||
|
||||
## Using {% data variables.copilot.copilot_spaces %} in your IDE
|
||||
|
||||
You can also access the information and context from {% data variables.copilot.copilot_spaces_short %} directly in your IDE using the {% data variables.product.github %} MCP server. This allows you to leverage your curated context while coding without switching between your IDE and the web interface.
|
||||
|
||||
This functionality is available in any IDE that supports the {% data variables.product.prodname_copilot %} extension and the {% data variables.product.github %} MCP server.
|
||||
|
||||
>[!NOTE] When using {% data variables.copilot.copilot_spaces_short %} in your IDE, repository context is not supported. You will have access to all other sources and instructions from the space.
|
||||
|
||||
Once you've accessed space context from your IDE:
|
||||
|
||||
* The space's context will inform {% data variables.product.prodname_copilot_short %}'s responses
|
||||
* You can reference the space's content when generating code, getting explanations, or working on development tasks
|
||||
* Your spaces stay in sync as your project evolves. {% data variables.product.github %} files and other {% data variables.product.github %}-based sources added to a space are automatically updated as they change, making {% data variables.product.prodname_copilot_short %} an evergreen expert in your project
|
||||
|
||||
### Prerequisites
|
||||
|
||||
To use {% data variables.copilot.copilot_spaces_short %} in your IDE, you need to install the {% data variables.product.github %} MCP server. For setup instructions, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server).
|
||||
|
||||
### Accessing space context from your IDE
|
||||
|
||||
For more detailed information on using the {% data variables.product.github %} MCP server in a specific IDE, see [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server).
|
||||
|
||||
Note that {% data variables.copilot.copilot_spaces_short %} can only be used in agent mode in your IDE, since spaces are accessed via the {% data variables.product.github %} MCP server.
|
||||
|
||||
1. In your IDE, open {% data variables.copilot.copilot_chat_short %} and select **Agent** from the mode dropdown or select the **Agent** tab.
|
||||
* To confirm that the {% data variables.copilot.copilot_spaces_short %} tools are enabled, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon. In the dropdown, expand the list of available tools for **MCP Server: github**, and confirm that the `get_copilot_space` and `list_copilot_spaces` tools are enabled.
|
||||
1. In the {% data variables.copilot.copilot_chat_short %} box, enter a prompt that references the space that you want to use as context. If you know the exact name of the space and the name of the user or organization that owns the space, you can provide that. Otherwise, {% data variables.product.prodname_copilot_short %} will automatically use the `list_copilot_spaces` tool to find spaces that match the name or text you provide and access the context from those spaces.
|
||||
|
||||
For example, you could use either of these two prompts:
|
||||
* `Using the Copilot space 'Checkout Flow Redesign' owned by myorganization, summarize the implementation plan.`
|
||||
* `Summarize the implementation plan from the Copilot space for the checkout flow redesign.`
|
||||
|
||||
Follow-up prompts in the same chat conversation will have access to the same spaces, without you having to reference it explicitly.
|
||||
|
||||
## Next steps
|
||||
|
||||
* To learn more about how to use {% data variables.copilot.copilot_spaces_short %} to help you with development work, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/speeding-up-development-work-with-copilot-spaces).
|
||||
* To learn how to share your space with your team, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces).
|
||||
@@ -13,8 +13,6 @@ redirect_from:
|
||||
contentType: tutorials
|
||||
---
|
||||
|
||||
{% data reusables.copilot.copilot-spaces.preview-note %}
|
||||
|
||||
If you're starting a new feature, trying to understand a system, or picking up a task in a codebase you’re still learning, {% data variables.copilot.copilot_spaces %} can help you:
|
||||
|
||||
* Stay focused by organizing the context you need in one place.
|
||||
|
||||
@@ -1,4 +1,2 @@
|
||||
* **Opt in to user feedback collection:** If enabled, users will see options to provide feedback on selected {% data variables.product.prodname_copilot_short %} features.
|
||||
* **Opt in to preview features:** If enabled, users can test new {% data variables.product.prodname_copilot_short %} features that are not yet generally available. Be aware that previews of features may have flaws, and the features may be changed or discontinued at any time. Current previews of {% data variables.product.prodname_copilot_short %} features include:
|
||||
|
||||
* {% data variables.copilot.copilot_spaces %}. See [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces).
|
||||
* **Opt in to preview features:** If enabled, users can test new {% data variables.product.prodname_copilot_short %} features that are not yet generally available. Be aware that previews of features may have flaws, and the features may be changed or discontinued at any time.
|
||||
|
||||
Reference in New Issue
Block a user