Skip to content

Commit ef916db

Browse files
committed
- Redo folder structure
- Neovim instructions - JetBrains plugin now in standard channel - Various minor tweaks
1 parent 514f073 commit ef916db

36 files changed

+46
-52
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To add a gallery example
1616

1717
* GIFs and videos are welcome, but please keep the file sizes small.
1818

19-
We'll highlight some of our favorites on the [README](/gallery/README.md) and on [Twitter](https://twitter.com/github).
19+
We'll highlight some of our favorites on the [README](gallery/README.md) and on [Twitter](https://twitter.com/github).
2020

2121
## Guidelines
2222

README.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
## NOTE: GitHub Copilot discussions have moved to the [Copilot Feedback forum](https://github.com/github/feedback/discussions/categories/copilot-feedback).
3-
---
4-
51
# GitHub Copilot ![Version](https://img.shields.io/badge/version-technical_preview-green)
62

73
<img width="128" alt="GitHub Copilot Logo" src="https://user-images.githubusercontent.com/28068/123712981-02676c80-d839-11eb-919a-96ee0c895e15.png">
@@ -12,11 +8,12 @@ In this repository, you can find documentation, walkthroughs, examples, and the
128

139
## Getting Started
1410

15-
For a tour of GitHub Copilot, visit the homepage at [copilot.github.com](https://copilot.github.com).
11+
To install GitHub Copilot, check out the Getting Started guides:
12+
- [Visual Studio Code](docs/visualstudiocode/gettingstarted.md#getting-started-with-github-copilot-in-visual-studio-code)
13+
- [JetBrains](docs/jetbrains/gettingstarted.md#getting-started-with-github-copilot-in-jetbrains)
14+
- [Neovim](https://github.com/github/copilot.vim#getting-started)
1615

17-
If this is your first time using GitHub Copilot, check out the Getting Started guides:
18-
- [Visual Studio Code](https://github.com/github/copilot-docs/blob/main/docs/gettingstartedvisualstudiocode.md)
19-
- [JetBrains](https://github.com/github/copilot-docs/blob/main/docs/gettingstartedjetbrains.md)
16+
For a tour of GitHub Copilot, visit the homepage at [copilot.github.com](https://copilot.github.com).
2017

2118
## How to get help
2219

@@ -34,19 +31,18 @@ or offensive output from GitHub Copilot, please report it privately to
3431
## Useful links
3532

3633
- [GitHub Copilot homepage](https://copilot.github.com)
37-
- [Getting started guide](https://github.com/github/copilot-docs/blob/main/docs/gettingstarted.md)
38-
- [Gallery](https://github.com/github/copilot-docs/tree/main/gallery)
39-
- [Documentation](https://github.com/github/copilot-docs/tree/main/docs)
34+
- [Gallery](gallery)
35+
- [Documentation](docs)
4036
- [Feedback forum](https://github.com/github/feedback/discussions/categories/copilot-feedback)
4137

4238
## Code of conduct
4339

4440
All users of GitHub Copilot are expected to comply with our
45-
[Code of Conduct](https://github.com/github/copilot-docs/blob/main/CODE_OF_CONDUCT.md).
41+
[Code of Conduct](CODE_OF_CONDUCT.md).
4642
By participating in this repository, you are also agreeing to the same
4743
[Terms of Service](https://help.github.com/articles/github-terms-of-service/) that you agree to when using GitHub.com.
4844

4945
## License
5046

51-
Content in this repository is released under [CC-BY-4.0](https://github.com/github/copilot-docs/blob/main/LICENSE.txt).
47+
Content in this repository is released under [CC-BY-4.0](LICENSE.txt).
5248
When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).

docs/README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
1-
# GitHub Copilot documentation
1+
## Getting Started
22

3-
* [Getting Started Guide](gettingstarted.md)
4-
* [Configuring GitHub Copilot](configuring.md)
5-
* [GitHub Copilot and other Extensions](extensions.md)
3+
To install GitHub Copilot, check out the Getting Started guides:
4+
- [Visual Studio Code](visualstudiocode/gettingstarted.md#getting-started-with-github-copilot-in-visual-studio-code)
5+
- [JetBrains](jetbrains/gettingstarted.md#getting-started-with-github-copilot-in-jetbrains)
6+
- [Neovim](https://github.com/github/copilot.vim#getting-started)
7+
8+
For a tour of GitHub Copilot, visit the homepage at [copilot.github.com](https://copilot.github.com).
9+
10+
## Full documentation
11+
12+
- [Visual Studio Code](visualstudiocode)
13+
- [JetBrains](jetbrains)
14+
- [Neovim](https://github.com/github/copilot.vim/blob/release/doc/copilot.txt)

docs/configuring.md

-10
This file was deleted.

docs/gettingstarted.md

-11
This file was deleted.

docs/jetbrains/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# GitHub Copilot for JetBrains documentation
2+
3+
* [Getting Started Guide](gettingstarted.md)
4+
* [Configuring GitHub Copilot for JetBrains](configuring.md)
5+
6+
See also the full [GitHub Copilot documentation](../README.md)
File renamed without changes.

docs/gettingstartedjetbrains.md docs/jetbrains/gettingstarted.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,7 @@
1414
<a name="installing"></a>
1515
## 1. Installing the JetBrains extension
1616

17-
1. Add the "super early birds" plugin repository
18-
19-
- Go to Preferences -> Plugins -> Settings Icon -> Manage Plugin Repositories
20-
- Add `https://plugins.jetbrains.com/plugins/super-early-bird/list`
21-
22-
<img src="resources\early-birds_jetbrains.png" width="600px" alt="Adding a plugin repository"/>
23-
24-
- **Restart** the IDE to pick up the new plugin repository
25-
17+
1. We have tested with the following JetBrains IDEs: IntelliJ and PyCharm versions 2021.2 and above.
2618
2. From the JetBrains marketplace, search for 'github copilot'. (You must include the 'github' to avoid other plug-ins with similar names.)
2719

2820
<img src='resources\search-for-github-copilot_jetbrains.png' width="600px" alt="Search for `github copilot`"/>
@@ -157,7 +149,7 @@ and can generate entire functions from something as simple as a comment.
157149

158150
GitHub Copilot has even more capabilities.
159151
Check out the examples on [copilot.github.com](https://copilot.github.com) to see more,
160-
or the [Gallery](https://github.com/github/copilot-docs/tree/main/gallery) in
152+
or the [Gallery](../../gallery) in
161153
this repository for the latest examples from us and the community.
162154

163155
Got an example of your own? We welcome you to share it on our [Feedback forum](https://github.com/github/feedback/discussions/categories/copilot-feedback).
@@ -183,7 +175,11 @@ Copilot. If you wish to rebind them, check out [the configuration guide](configu
183175
<a name="enabling"></a>
184176
## 8. Enabling and disabling GitHub Copilot
185177

186-
You can logout (or login) from Copilot from the `Tools`/`GitHub Copilot` menu.
178+
There's a setting to turn on or off the automatic completions. You can find the setting at `Preferences... > Languages & Frameworks > GitHub Copilot`.
179+
180+
<img alt="The GitHub Copilot preferences" src="resources\preferences.png" width="600"></img>
181+
182+
You can also logout (or login) from Copilot from the `Tools`/`GitHub Copilot` menu.
187183

188184
<img alt="The GitHub Copilot submenu in the Tools menu" src="resources\logout_jetbrains.png" width="600"></img>
189185

File renamed without changes.
Loading
20.6 KB
Loading
File renamed without changes.
Loading
-27.1 KB
Binary file not shown.
-34.6 KB
Binary file not shown.

docs/visualstudiocode/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# GitHub Copilot for VSCode documentation
2+
3+
* [Getting Started Guide](gettingstarted.md)
4+
* [Configuring GitHub Copilot for VSCode](configuring.md)
5+
* [GitHub Copilot and other VSCode Extensions](extensions.md)
6+
7+
See also the full [GitHub Copilot documentation](../README.md)
File renamed without changes.
File renamed without changes.

docs/gettingstartedvisualstudiocode.md docs/visualstudiocode/gettingstarted.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Press `Tab` then `Enter` to accept each line.
152152
153153
GitHub Copilot can do even more.
154154
Check out the examples on [copilot.github.com](https://copilot.github.com) to see more,
155-
or the [Gallery](https://github.com/github/copilot-docs/tree/main/gallery) in
155+
or the [Gallery](../../gallery) in
156156
this repository for the latest examples from us and the community.
157157
158158
Got an example of your own? We welcome you to share it on our [Feedback forum](https://github.com/github/feedback/discussions/categories/copilot-feedback).
File renamed without changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
File renamed without changes.

gallery/ruby-twitter-api-example/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [Copilot examples](../README.md)[Publish a Tweet](/README.md) (Ruby)
1+
# [Copilot examples](../README.md)[Publish a Tweet](README.md) (Ruby)
22

33
In this example we write some Ruby to publish a Tweet with the assumption that you have no prior experience of doing so, nor knowledge of what 3rd party Ruby Gems or code snippets can be used.
44

0 commit comments

Comments
 (0)