Skip to content

Commit fb5eb8a

Browse files
authored
Merge pull request #38610 from github/repo-sync
Repo sync
2 parents 574274f + 5a54e0d commit fb5eb8a

File tree

15 files changed

+293
-6
lines changed

15 files changed

+293
-6
lines changed

.github/copilot-instructions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
This documentation repository consists mainly of content written in Markdown format. These files are converted into HTML for displaying on a website. Most Markdown files become a single article on the documentation site. Other files contain reusable content which is inserted into multiple articles. The repository also contains YAML files (e.g. for variable text), image files, JavaScript/TypeScript files, etc.
2+
3+
### Using variables
4+
5+
Within Markdown files, with the exception of the `title` field in the metadata at the start of a file, always use the Liquid syntax variables rather than text if a variable has been defined for that text. For example:
6+
7+
| Use this variable | Don't use this text | File where variable is defined |
8+
| --- | --- | --- |
9+
| `{% data variables.product.prodname_dotcom %}` | GitHub | data/variables/product.yml |
10+
| `{% data variables.product.prodname_ghe_server %}` | GitHub Enterprise Server | data/variables/product.yml |
11+
| `{% data variables.product.prodname_copilot_short %}` | Copilot | data/variables/product.yml |
12+
| `{% data variables.product.prodname_copilot %}` | GitHub Copilot | data/variables/product.yml |
13+
| `{% data variables.copilot.copilot_code-review_short %}` | Copilot code review | data/variables/copilot.yml |
14+
| `{% data variables.enterprise.prodname_managed_user %}` | managed user account | data/variables/enterprise.yml |
15+
| `{% data variables.code-scanning.codeql_workflow %}` | CodeQL analysis workflow | data/variables/code-scanning.yml |
16+
17+
There are many more variables. These are stored in various YAML files within the `data/variables` directory.

content/copilot/about-github-copilot/github-copilot-features.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ Enhance {% data variables.product.prodname_copilot_chat_short %} responses by pr
6868

6969
Automatically generate commit messages and descriptions with {% data variables.product.prodname_copilot_desktop_short %} based on the changes you make to your project.
7070

71+
### {% data variables.product.prodname_copilot_spaces %} ({% data variables.release-phases.public_preview %})
72+
73+
Organize and centralize relevant content—like code, docs, specs, and more—into {% data variables.product.prodname_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).
74+
7175
### {% data variables.product.prodname_copilot_short %} knowledge bases _({% data variables.product.prodname_copilot_enterprise_short %} only)_
7276

7377
Create and manage collections of documentation to use as context for chatting with {% data variables.product.prodname_copilot_short %}. When you ask a question in {% data variables.product.prodname_copilot_chat_dotcom_short %} or in {% data variables.product.prodname_vscode_shortname %}, you can specify a knowledge base as the context for your question. See [AUTOTITLE](/copilot/customizing-copilot/managing-copilot-knowledge-bases).

content/copilot/about-github-copilot/what-is-github-copilot.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ redirect_from:
3636
* Get code suggestions as you type in your IDE
3737
* Chat with {% data variables.product.prodname_copilot_short %} to ask for help with your code
3838
* Ask {% data variables.product.prodname_copilot_short %} for help using the command line
39+
* Organize and share task-specific context with {% data variables.product.prodname_copilot_spaces %} to get more relevant answers
3940
* Generate a description of the changes in a pull request _({% data variables.product.prodname_copilot_enterprise_short %} only)_
4041
* Create and manage collections of documentation, called knowledge bases, to use as a context for chatting with {% data variables.product.prodname_copilot_short %} _({% data variables.product.prodname_copilot_enterprise_short %} only)_
4142
* Work on code changes and create a pull request for you to review _({% data variables.product.prodname_copilot_pro_plus_short %} and {% data variables.product.prodname_copilot_enterprise_short %} only)_

content/copilot/customizing-copilot/managing-copilot-knowledge-bases.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ redirect_from:
2020
- /copilot/github-copilot-enterprise/copilot-docset-management/about-copilot-docset-management
2121
---
2222

23+
> [!TIP] If you're looking for a more flexible way to organize context for {% data variables.product.prodname_copilot_short %}, you can also try {% data variables.product.prodname_copilot_spaces %}.
24+
>
25+
> {% data variables.product.prodname_copilot_spaces_short %} let you combine code and free-text content—like transcripts or specs—and can be created by any {% data variables.product.prodname_copilot_short %} user, not just organization owners. They’re a good option for more focused or task-specific use cases. See [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces).
26+
2327
## About knowledge bases
2428

2529
Organization owners can create knowledge bases, bringing together Markdown documentation across one or more repositories. Organization members can then specify that knowledge base as the context for {% data variables.product.prodname_copilot_chat_dotcom_short %}, {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}, and {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}.

content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Organization owners can set policies to govern how {% data variables.product.pro
3232
* Image support in {% data variables.product.prodname_copilot_chat_short %} (available in {% data variables.product.prodname_vscode_shortname %} and {% data variables.product.prodname_vs %})
3333
>[!NOTE] This setting only applies to preview features within {% data variables.product.prodname_copilot_short %} and does not control all preview-related settings in {% data variables.product.prodname_vscode_shortname %}.
3434
* {% data variables.copilot.copilot_coding_agent %} ({% data variables.release-phases.public_preview %})
35+
* {% data variables.product.prodname_copilot_spaces %} (public preview)
3536
* MCP servers on {% data variables.product.prodname_dotcom_the_website %} ({% data variables.release-phases.public_preview %})
3637
* {% data variables.product.prodname_copilot_mobile_short %}
3738
* {% data variables.product.prodname_copilot_cli_short %} and {% data variables.product.prodname_windows_terminal %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: About organizing and sharing context with Copilot Spaces
3+
shortTitle: Organize and share context
4+
intro: 'Understand how gathering context with {% data variables.product.prodname_copilot_spaces %} can improve your results and help your teammates.'
5+
permissions: 'Anyone with a {% data variables.product.prodname_copilot_short %} license can use {% data variables.product.prodname_copilot_spaces_short %}.'
6+
versions:
7+
feature: copilot
8+
type: overview
9+
topics:
10+
- Copilot
11+
---
12+
13+
{% data reusables.copilot.copilot-spaces.preview-note %}
14+
15+
{% data variables.product.prodname_copilot_spaces %} let you organize the context that {% data variables.product.prodname_copilot_short %} uses to answer your questions. {% data variables.product.prodname_copilot_spaces_short %} can include code from repositories, free-text content like transcripts or notes, and more—grouped together in one place. 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.
16+
17+
## Why use {% data variables.product.prodname_copilot_spaces %}?
18+
19+
Whether you’re working solo or collaborating across a team, {% data variables.product.prodname_copilot_spaces_short %} help you make {% data variables.product.prodname_copilot_short %} more useful.
20+
21+
With {% data variables.product.prodname_copilot_spaces %} you can:
22+
23+
* Get more relevant, specific answers from {% data variables.product.prodname_copilot_short %}.
24+
* Stay in flow by collecting what you need for a task in one place.
25+
* Reduce repeated questions by sharing knowledge with your team.
26+
* Support onboarding and reuse with self-service context that lives beyond chat history.
27+
28+
### How are {% data variables.product.prodname_copilot_spaces_short %} different from knowledge bases?
29+
30+
{% data variables.product.prodname_copilot_spaces_short %} are optimized for specific tasks and grounded conversations. Because context in {% data variables.product.prodname_copilot_spaces_short %} is scoped, {% data variables.product.prodname_copilot_short %}'s responses are more accurate and relevant.
31+
32+
{% rowheaders %}
33+
34+
| | {% data variables.product.prodname_copilot_spaces %} | Knowledge bases |
35+
| -------------------- | --------------------------- | -------------------------------------------------------------- |
36+
| Who can create | Anyone with a {% data variables.product.prodname_copilot_short %} license | Organization owners |
37+
| Owned by | Organizations or individual users | Organizations |
38+
| Content type | Any code hosted in repositories and free-text content | Markdown files hosted in {% data variables.product.github %}
39+
| Context handling | Limited in size, which guarantees higher response quality given the focused selection | Unlimited, but that comes with reduced response quality |
40+
41+
{% endrowheaders %}
42+
43+
## Who can use {% data variables.product.prodname_copilot_spaces_short %}?
44+
45+
Anyone with a {% data variables.product.prodname_copilot_short %} license, including {% data variables.product.prodname_copilot_free_short %}, can create and use {% data variables.product.prodname_copilot_spaces_short %}.
46+
47+
{% data reusables.copilot.editor-preview-settings %}
48+
49+
{% data variables.product.prodname_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 (read-only) or kept private to the person who created the space.
50+
51+
Questions you submit in a space count as {% data variables.product.prodname_copilot_chat_short %} requests.
52+
53+
* If you're a {% data variables.product.prodname_copilot_free_short %} user, this usage counts toward your monthly chat limit.
54+
* If you use {% data variables.product.prodname_copilot_spaces_short %} with a premium model, this usage counts toward your premium usage quota.
55+
56+
## Next steps
57+
58+
To start using {% data variables.product.prodname_copilot_spaces_short %}, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/creating-and-using-copilot-spaces).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Collaborating with your team using Copilot Spaces
3+
shortTitle: Collaborate with your team
4+
intro: 'Learn how to share {% data variables.product.prodname_copilot_spaces %} with your team to support collaboration and knowledge sharing.'
5+
permissions: 'Anyone with a {% data variables.product.prodname_copilot_short %} license can use {% data variables.product.prodname_copilot_spaces_short %}.'
6+
versions:
7+
feature: copilot
8+
type: how_to
9+
topics:
10+
- Copilot
11+
---
12+
13+
{% data reusables.copilot.copilot-spaces.preview-note %}
14+
15+
{% data variables.product.prodname_copilot_spaces %} let you organize the context that {% data variables.product.prodname_copilot_short %} uses to answer your questions. Sharing {% data variables.product.prodname_copilot_spaces %} helps your team:
16+
17+
* Avoid repeated explanations and handoffs.
18+
* Stay aligned on how a system works or what’s expected.
19+
* Learn from past work, documentation, and examples.
20+
* Get better help from {% data variables.product.prodname_copilot_short %} with grounded, team-curated context.
21+
22+
## Use cases for team collaboration
23+
24+
* **Onboarding**: Share a space with key code, docs, and checklists to help new developers get started faster.
25+
* **System knowledge**: Create a space for a complex system or workflow (like authentication or CI pipelines) that other people can reference.
26+
* **Style guides or review checklists**: Document standards and examples in a space that {% data variables.product.prodname_copilot_short %} can reference when suggesting changes.
27+
28+
For example, a subject matter expert creates a space called “Accessibility Reviews” that includes your team’s internal accessibility checklist, product guidelines, and WCAG documentation. Developers can ask {% data variables.product.prodname_copilot_short %} questions directly in the space to ensure they're following the latest guidelines in their work.
29+
30+
## Sharing {% data variables.product.prodname_copilot_spaces_short %}
31+
32+
When you create a space, you can choose whether it’s owned by you or by one of your organizations. If you choose an organization:
33+
34+
* You can share the space with others in the organization, giving read access to all organization members.
35+
* Other people with access can view the context, use {% data variables.product.prodname_copilot_short %} within the space, and ask questions.
36+
37+
If you choose to create a personal space, **you can't share it with others**.
38+
39+
To share a space with your organization:
40+
41+
1. In the top right corner of the space, click **{% octicon "kebab-horizontal" aria-hidden="true" aria-label="kebab-horizontal" %}**, then click **{% octicon "share" aria-hidden="true" aria-label="share" %} Share**.
42+
1. Change the base role to "The entire organization can access".
43+
44+
Other people in your organization can now view the space in the "Organizations" tab and use it to ask questions. Additionally, you can also click **{% octicon "link" aria-label="the link" %} Copy link** to copy the link to the space and share it with others.
45+
46+
## Accessing shared {% data variables.product.prodname_copilot_spaces_short %}
47+
48+
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).
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Creating and using Copilot Spaces
3+
shortTitle: Create and use Copilot Spaces
4+
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.'
5+
permissions: 'Anyone with a {% data variables.product.prodname_copilot_short %} license can use {% data variables.product.prodname_copilot_spaces_short %}.'
6+
versions:
7+
feature: copilot
8+
type: how_to
9+
topics:
10+
- Copilot
11+
---
12+
13+
{% data reusables.copilot.copilot-spaces.preview-note %}
14+
15+
1. To create a space, go to [https://github.com/copilot/spaces](https://github.com/copilot/spaces), and click **Create space**.
16+
1. Give your space a name.
17+
1. Choose whether the space is owned by you or by an organization you belong to. Organization-owned {% data variables.product.prodname_copilot_spaces_short %} can be shared using {% data variables.product.github %}’s built-in permission model.
18+
1. Optionally, add a description to help others understand the purpose of the space.
19+
1. Click **Create**.
20+
21+
## Adding context to {% data variables.product.prodname_copilot_spaces_short %}
22+
23+
You can add two types of context to your space:
24+
25+
* **Instructions**: Free text that describes what {% data variables.product.prodname_copilot_short %} should focus on within this space. Include its areas of expertise, what kinds of tasks it should help with, and what it should avoid. This helps {% data variables.product.prodname_copilot_short %} give more relevant responses based on your intent.
26+
27+
For example:
28+
29+
> You are a SQL generator. Your job is to take the sample queries and data schemas defined in the attached files and and generate SQL queries based on the user's goals.
30+
31+
* **References**: You can add any code hosted in {% data variables.product.github %} repositories, including public and private repositories. You can also add free-text content, such as transcripts or notes.
32+
33+
>[!TIP] You don’t need formal docs to get value from {% data variables.product.prodname_copilot_spaces_short %}. Try pasting in a Slack thread, a video call summary, or even bullet-point notes.
34+
35+
This context will be used to provide more relevant answers to your questions. Additionally, {% data variables.product.prodname_copilot_spaces_short %} will always refer to the latest version of the code on the `main` branch of the repository.
36+
37+
## Using {% data variables.product.prodname_copilot_spaces_short %}
38+
39+
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.
40+
41+
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 about choosing the right AI model, see [AUTOTITLE](/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task).
42+
43+
## Next steps
44+
45+
* To learn more about how to use {% data variables.product.prodname_copilot_spaces_short %} to help you with development work, see [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/speeding-up-development-work-with-copilot-spaces).
46+
* 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).
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Copilot Spaces
3+
intro: "Organize and centralize relevant content into {% data variables.product.prodname_copilot_spaces_short %} that ground {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task."
4+
versions:
5+
feature: copilot
6+
topics:
7+
- Copilot
8+
children:
9+
- /about-organizing-and-sharing-context-with-copilot-spaces
10+
- /creating-and-using-copilot-spaces
11+
- /speeding-up-development-work-with-copilot-spaces
12+
- /collaborating-with-your-team-using-copilot-spaces
13+
---

0 commit comments

Comments
 (0)