Skip to content

Commit 04083bf

Browse files
committed
update manual
1 parent 8129f2e commit 04083bf

23 files changed

+602
-215
lines changed

README.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
# Copilot Workspace User Manual
22

3-
Welcome! This is the user manual for Copilot Workspace, an experiment by GitHub Next. Copilot Workspace is
4-
a Copilot-native development environment that allows you to collaborate with Copilot to solve coding tasks
5-
at the level of an entire repository. You can learn more about what Copilot Workspace is at the [project page](https://githubnext.com/projects/copilot-workspace/).
3+
Welcome! This is the user manual for Copilot Workspace, an experiment by GitHub Next. Copilot Workspace is a Copilot-native development environment that allows you to collaborate with Copilot to solve coding tasks at the level of an entire repository. You can learn more about what Copilot Workspace is at the [project page](https://githubnext.com/projects/copilot-workspace/).
64

7-
This manual will help you understand how to use Copilot Workspace most effectively, and will share tips and tricks
8-
that we've learned while using Copilot Workspace to build Copilot Workspace.
5+
This manual will help you understand how to use Copilot Workspace most effectively, and will share tips and tricks that we've learned while using Copilot Workspace to build Copilot Workspace.
96

107
## Table of Contents
118

12-
* [Conceptual Overview](conceptual-overview.md)
9+
* [Overview](overview.md)
1310
* [Getting Started](getting-started.md)
1411
* [Tips and Tricks](tips-and-tricks.md)
12+
* [Terminal/Codespaces Guide](codespaces-guide.md)
13+
* Going Further
14+
- [Creating Repositories](creating-repos.md)
15+
- [Ad-hoc Tasks](adhoc-tasks.md)
16+
- [Pull Request Tasks](pull-request-tasks.md)
17+
- [Controls for Repository Maintainers](repo-maintainers.md)
18+
- [Experiments, Roadmap and Known Issues](known-issues.md)
19+
- [Further Techniques](further-techniques.md)
20+
- [Responsible AI FAQ](responsible-ai-faq.md)
21+
- [Origins](origins.md)
1522

1623
## Feedback
1724

18-
To give general feedback, please join the [GitHub Next Discord](https://discord.gg/FeGshJZ2yy) and post in the #copilot-workspace channel. Please provide a share link to the workspace and a description of the issue you're facing
19-
so that we can help you more effectively.
25+
To give general feedback, please join the [GitHub Next Discord](https://discord.gg/FeGshJZ2yy) and post in the #copilot-workspace channel. Please provide a share link to the workspace and a description of the issue you're facing so that we can help you more effectively.
2026

21-
To report harmful content, please email [email protected] with a description of the issue and a share link to the workspace.
27+
To report harmful content, please email [email protected] with a description of the issue and a share link to the workspace.

adhoc-tasks.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Ad-hoc Tasks
2+
3+
An ad-hoc task is a task that you define yourself, without the context of an issue or pull request. You can start an ad-hoc task from the Copilot Workspace dashboard, or from the repository page on GitHub.com.
4+
5+
<img src="images/ad-hoc-task-full.png" width=400 alt="Panel on repository page to open an ad-hoc task in Copilot Workspace"><br>*Start an ad-hoc task in Copilot Workspace*
6+
7+
Once started an ad-hoc task looks like this:
8+
9+
<img src="images/adhoc-task-timeline-representation.png" width=600 alt="Ad-hoc task timeline representation"><br>*The timeline starts with the ad-hoc task and has no associated metadata*
10+
11+
After creation, ad-hoc tasks proceed as for issue tasks.

codespaces-guide.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Codespaces Starter Guide
2+
3+
This document contains useful information for using the terminal/Codespace in your Workspace session.
4+
5+
## Codespaces Limits
6+
7+
### Overall Usage
8+
9+
The technical preview includes limited free Codespaces compute usage that is reset at the start of the calendar month.
10+
11+
### Overall Limits
12+
13+
The technical preview enforces a total Codespaces and total active Codespaces limits that you may encounter. If closing Workspace sessions does not resolve these issues you may reach out to us [here](https://github.com/githubnext/copilot-workspace-user-manual?tab=readme-ov-file#feedback).
14+
15+
### Organization based limits and policies
16+
If the Organization that owns the repository has set policies for Codespaces usage they will be applied to being able to create Codespaces for Workspace. You should reach out to an administrator of the organization to adjust any policies.
17+
18+
## Common Errors
19+
20+
#### You've reached your Copilot Workspace usage limit
21+
22+
At the start of the next calendar month your free usage limit will reset and you can continue using Workspace. You may reach out to us and give us feedback about the usage limit [here](https://github.com/githubnext/copilot-workspace-user-manual?tab=readme-ov-file#feedback).
23+
24+
#### Limit of active Copilot Workspace reached.
25+
26+
Remediate this by closing open Workspace sessions and allowing previous sessions to shutdown before creating new ones.
27+
28+
#### Limit of Copilot Workspace reached.
29+
Remediate this by closing open Workspace sessions and allowing previous sessions to shutdown before creating new ones.
30+
31+
#### Repository may not be used for a Codespace
32+
33+
This may be because of a repository or organization policy restricting Codespaces creation. Please check any settings in the organization or repository that may be preventing Codespaces usage. If you do not find any please reach out to our [technical
34+
preview feedback channels](https://github.com/githubnext/copilot-workspace-user-manual?tab=readme-ov-file#feedback) for assistance.
35+
36+
#### The assigned location is currently unavailable.
37+
38+
You may try again in a few minutes. Additionally, you can change your default Codespaces region in your user settings if you continue to run into this error for a particular region by following these [public docs](https://docs.github.com/en/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces).
39+
40+
#### Provided `devcontainer.json` cannot be parsed to valid JSON
41+
42+
In the chosen repository you may need to fix the `devcontainer.json` for syntax errors. You can read more about `devcontainer.json` syntax in the following [public docs](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
43+
44+
#### The organization has enabled OAuth App access restrictions, meaning that access to Copilot Workspace is limited.
45+
46+
Reach out to the organization administrator to give access to the Copilot Workspace OAuth app.

0 commit comments

Comments
 (0)