Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

please make this available on Atom #22

Open
wants to merge 31 commits into
base: old-main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
514f073
Update README.md
hsenag Oct 25, 2021
ef916db
- Redo folder structure
hsenag Oct 25, 2021
153681b
Create gettingstarted.md
hsenag Oct 27, 2021
8589e1b
Spell out Visual Studio Code
andrewlayman Oct 27, 2021
bf92748
Spell-out Visual Studio Code
andrewlayman Oct 27, 2021
a4ea93d
Merge pull request #3 from github/andrewlayman-patch-1
andrewlayman Oct 27, 2021
794674f
Update gettingstarted.md
FaisalAfroz Oct 29, 2021
3af6570
Spell-out Visual Studio Code.
FaisalAfroz Oct 31, 2021
f807337
Spell-out Visual Studio Code
Jiangmenghao Nov 2, 2021
8d71404
Merge pull request #6 from Jiangmenghao/doc-fixes
hsenag Nov 2, 2021
2b3fa3f
Merge pull request #5 from FaisalAfroz/main
hsenag Nov 2, 2021
5f0f46a
Spelling out Visual Studio Code likewise
njmsaikat Nov 3, 2021
0a57064
Merge pull request #7 from FaisalAfroz/doc-fix
orph Nov 3, 2021
132eb60
Merge pull request #8 from njmsaikat/patch-1
orph Nov 3, 2021
e149a90
Remove `)` in gettingstarted.md
masoodkamyab Nov 6, 2021
678dd7e
Merge pull request #13 from masoodkamyab/patch-1
hsenag Nov 6, 2021
62f4693
Add the Copilot icon
hsenag Jan 5, 2022
fed6cf8
Add docs for Visual Studio extension
hsenag Mar 8, 2022
bbaf312
Update gettingstarted.md
hsenag Mar 8, 2022
8be024e
Add instructions find marketplace in Plugins.
elena Mar 27, 2022
5cbc325
Merge pull request #23 from elena/main
hsenag Mar 28, 2022
57d02d0
Document situation with IntelliCode and Copilot
hsenag Apr 21, 2022
1fedbf5
Update gettingstarted.md
hsenag Apr 26, 2022
0de46cb
Merge pull request #32 from github/hsenag-patch-1
hsenag Apr 26, 2022
9acfd2f
Fix the TOC
hsenag Apr 26, 2022
1e46f9a
These docs are now obsolete - replace with a pointer to the official …
hsenag Jul 11, 2022
6399231
Tweak language
hsenag Jul 11, 2022
dd037c5
Tweak a bit more
hsenag Jul 11, 2022
eac9901
Drop tech preview banner
hsenag Jul 11, 2022
c4d476a
Update README.md
hsenag Jul 11, 2022
1c0f525
Merge pull request #53 from github/hsenag/redirect-docs
hsenag Jul 11, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To add a gallery example

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

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

## Guidelines

Expand Down
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
## NOTE: GitHub Copilot discussions have moved to the [Copilot Feedback forum](https://github.com/github/feedback/discussions/categories/copilot-feedback).
---

# GitHub Copilot ![Version](https://img.shields.io/badge/version-technical_preview-green)

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

## Getting Started

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

If this is your first time using GitHub Copilot, check out the
[Getting Started guide](https://github.com/github/copilot-docs/blob/main/docs/gettingstarted.md).
For a tour of GitHub Copilot, visit the homepage at [copilot.github.com](https://copilot.github.com).

## How to get help

Expand All @@ -33,19 +32,18 @@ or offensive output from GitHub Copilot, please report it privately to
## Useful links

- [GitHub Copilot homepage](https://copilot.github.com)
- [Getting started guide](https://github.com/github/copilot-docs/blob/main/docs/gettingstarted.md)
- [Gallery](https://github.com/github/copilot-docs/tree/main/gallery)
- [Documentation](https://github.com/github/copilot-docs/tree/main/docs)
- [Gallery](gallery)
- [Documentation](docs)
- [Feedback forum](https://github.com/github/feedback/discussions/categories/copilot-feedback)

## Code of conduct

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

## License

Content in this repository is released under [CC-BY-4.0](https://github.com/github/copilot-docs/blob/main/LICENSE.txt).
Content in this repository is released under [CC-BY-4.0](LICENSE.txt).
When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
Binary file added assets/Copilot-APP-ICON-512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 15 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# GitHub Copilot documentation
## Getting Started

* [Getting Started Guide](gettingstarted.md)
* [Configuring GitHub Copilot](configuring.md)
* [GitHub Copilot and other Extensions](extensions.md)
To install GitHub Copilot, check out the Getting Started guides:
- [Visual Studio](visualstudio/gettingstarted.md#getting-started-with-github-copilot-in-visual-studio)
- [Visual Studio Code](visualstudiocode/gettingstarted.md#getting-started-with-github-copilot-in-visual-studio-code)
- [JetBrains](jetbrains/gettingstarted.md#getting-started-with-github-copilot-in-jetbrains)
- [Neovim](https://github.com/github/copilot.vim#getting-started)

For a tour of GitHub Copilot, visit the homepage at [copilot.github.com](https://copilot.github.com).

## Full documentation

- [Visual Studio](visualstudio)
- [Visual Studio Code](visualstudiocode)
- [JetBrains](jetbrains)
- [Neovim](https://github.com/github/copilot.vim/blob/release/doc/copilot.txt)
10 changes: 0 additions & 10 deletions docs/configuring.md

This file was deleted.

19 changes: 12 additions & 7 deletions docs/gettingstarted.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# Getting Started with GitHub Copilot
## Getting Started

- [Visual Studio Code](./gettingstartedvisualstudiocode.md)
- [JetBrains](./gettingstartedjetbrains.md)
To install GitHub Copilot, check out the Getting Started guides:
- [Visual Studio](visualstudio/gettingstarted.md#getting-started-with-github-copilot-in-visual-studio)
- [Visual Studio Code](visualstudiocode/gettingstarted.md#getting-started-with-github-copilot-in-visual-studio-code)
- [JetBrains](jetbrains/gettingstarted.md#getting-started-with-github-copilot-in-jetbrains)
- [Neovim](https://github.com/github/copilot.vim#getting-started)

For a tour of GitHub Copilot, visit the homepage at [copilot.github.com](https://copilot.github.com).

<a name="more"></a>
## Learn More
## Full documentation

To learn more about configuring GitHub Copilot, go to the [documentation table of
contents](README.md).
- [Visual Studio](visualstudio)
- [Visual Studio Code](visualstudiocode)
- [JetBrains](jetbrains)
- [Neovim](https://github.com/github/copilot.vim/blob/release/doc/copilot.txt)
6 changes: 6 additions & 0 deletions docs/jetbrains/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# GitHub Copilot for JetBrains documentation

* [Getting Started Guide](gettingstarted.md)
* [Configuring GitHub Copilot for JetBrains](configuring.md)

See also the full [GitHub Copilot documentation](../README.md)
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,7 @@
<a name="installing"></a>
## 1. Installing the JetBrains extension

1. Add the "super early birds" plugin repository

- Go to Preferences -> Plugins -> Settings Icon -> Manage Plugin Repositories
- Add `https://plugins.jetbrains.com/plugins/super-early-bird/list`

<img src="resources\early-birds_jetbrains.png" width="600px" alt="Adding a plugin repository"/>

- **Restart** the IDE to pick up the new plugin repository

1. We have tested with the following JetBrains IDEs: IntelliJ and PyCharm versions 2021.2 and above.
2. From the JetBrains marketplace, search for 'github copilot'. (You must include the 'github' to avoid other plug-ins with similar names.)

<img src='resources\search-for-github-copilot_jetbrains.png' width="600px" alt="Search for `github copilot`"/>
Expand Down Expand Up @@ -97,7 +89,7 @@ As the developer you are always in charge; you can select which suggestion to us
2. GitHub Copilot will again show you a suggested completion.

3. Instead of pressing `Tab`:
* On macOS, press `Option`+`]` for next or `Option`+`[`) for previous.
* On macOS, press `Option`+`]` for next or `Option`+`[` for previous.
* On Windows or Linux, press `Alt`+`]` for next or `Alt`+`[` for previous.

GitHub Copilot will cycle through other alternative suggestions.
Expand Down Expand Up @@ -157,7 +149,7 @@ and can generate entire functions from something as simple as a comment.

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

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).
Expand All @@ -183,7 +175,11 @@ Copilot. If you wish to rebind them, check out [the configuration guide](configu
<a name="enabling"></a>
## 8. Enabling and disabling GitHub Copilot

You can logout (or login) from Copilot from the `Tools`/`GitHub Copilot` menu.
There's a setting to turn on or off the automatic completions. You can find the setting at `Preferences... > Languages & Frameworks > GitHub Copilot`.

<img alt="The GitHub Copilot preferences" src="resources\preferences.png" width="600"></img>

You can also logout (or login) from Copilot from the `Tools`/`GitHub Copilot` menu.

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

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/jetbrains/resources/preferences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/resources/not-in-preview_jetbrains.png
Binary file not shown.
Binary file removed docs/resources/suggestion-class_jetbrains.png
Binary file not shown.
7 changes: 7 additions & 0 deletions docs/visualstudio/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# GitHub Copilot for Visual Studio documentation

* [Getting Started Guide](gettingstarted.md)
* [Configuring GitHub Copilot for Visual Studio](configuring.md)
* [Configuring Resharper for GitHub Copilot](resharper.md)

See also the full [GitHub Copilot documentation](../README.md)
34 changes: 34 additions & 0 deletions docs/visualstudio/configuring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Configuring GitHub Copilot for Visual Studio

<a name="settings"></a>
# Settings for the Extension

To configure GitHub Copilot's basic settings, click the GitHub Copilot status icon in the bottom panel of the Visual Studio window. To enable or disable GitHub Copilot, click the icon. You will be asked whether you wish to toggle globally, for the current file type, or current solution.

<img alt="icon" src="resources/visual-studio-copilot-settings.png" width="585"></img>

<a name="shortcuts"></a>
## Keyboard shortcuts

These are the most common Visual Studio keyboard shortcuts relevant for GitHub
Copilot.
If you wish to rebind the shortcuts, use the Tools | Options, Environment > Keyboard section and search for the command name below:

* Show next inline suggestion: `Ctrl + Alt + ]`.
`Tools.Nextsuggestion`

* Show previous inline suggestion: `Ctrl + Alt + [`.
`Tools.Previoussuggestion`

* Trigger inline suggestion: `Ctrl + Alt + \`.
`Edit.Copilot.TriggerInlineSuggestion`


<img alt="Keyboard options" src="resources/keyboard-options.png" width="600"></img>

<a name="more"></a>
## Learn More

To learn more about GitHub Copilot, go to the [documentation table of
contents](README.md).

Loading