feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Update Copilot docs

Browse Source 
- Update screenshot
- Add disclaimer
- Describe rejecting suggestions

Task-number: QTCREATORBUG-28996
Change-Id: I5b30c8f8760f5684e31beb534754d03684d3c394
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
This commit is contained in:
Leena Miettinen
2023-07-03 17:04:23 +02:00
parent acad4b6b2e
commit 7977d3ac37
2 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/qtcreator/images/qtcreator-preferences-copilot.webp
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 7.0 KiB

After

Width:  |  Height:  |  Size: 8.5 KiB

17
doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc
View File

@@ -12,6 +12,13 @@
\l{https://github.com/features/copilot}{GitHub Copilot} into \QC. \l{https://github.com/features/copilot}{GitHub Copilot} into \QC.
You can view suggestions from Copilot in the \uicontrol Edit mode. You can view suggestions from Copilot in the \uicontrol Edit mode.
\note If you enable the Copilot plugin, you must agree with and abide by
the GitHub terms of use. It is your responsibility to know and accept the
requirements and parameters of using Copilot, such as ensuring you have
the rights to grant it access to your code. Also, you must understand the
implications of using it and the suggestions it produces, such as code
copyright and accuracy.
\section1 Requirements \section1 Requirements
To use the Copilot plugin, you need: To use the Copilot plugin, you need:
@@ -42,11 +49,11 @@
\li Select \uicontrol Edit > \uicontrol Preferences > \li Select \uicontrol Edit > \uicontrol Preferences >
\uicontrol Copilot. \uicontrol Copilot.
\image qtcreator-preferences-copilot.webp {Copilot tab in Preferences} \image qtcreator-preferences-copilot.webp {Copilot tab in Preferences}
\li Select the \uicontrol {Enable Copilot} check box to use Copilot.
\li Select \uicontrol {Sign In} to sign into your subscription, activate \li Select \uicontrol {Sign In} to sign into your subscription, activate
your device, and authorize the GitHub Copilot plugin. your device, and authorize the GitHub Copilot plugin.
The button turns into a \uicontrol {Sign Out} button. The button turns into a \uicontrol {Sign Out} button.
\li Select the \uicontrol {Enable Copilot} check box to use Copilot.
\li In the \uicontrol {Node.js path} field, enter the full path to the \li In the \uicontrol {Node.js path} field, enter the full path to the
Node.js executable. Node.js executable.
\li In the \uicontrol {Path to agent.js} field, enter the path to \li In the \uicontrol {Path to agent.js} field, enter the path to
@@ -56,7 +63,7 @@
make changes. make changes.
\endlist \endlist
\section1 Pair-Programming with Copilot \section1 Receiving Suggestions
When you write code in the \l {Working in Edit Mode}{Edit} mode and When you write code in the \l {Working in Edit Mode}{Edit} mode and
\uicontrol {Request completions automatically} is enabled, Copilot \uicontrol {Request completions automatically} is enabled, Copilot
@@ -78,9 +85,11 @@
To apply a suggestion word-by-word, select \uicontrol {Apply Word} To apply a suggestion word-by-word, select \uicontrol {Apply Word}
or press \key {Alt+Right}. or press \key {Alt+Right}.
\section1 Enabling and Disabling Copilot To reject a suggestion, press \key Esc or the arrow keys.
You can enable and disable the Copilot plugin either globally for all \section1 Enabling and Disabling Suggestions
You can enable and disable the Copilot suggestions either globally for all
projects or at project level for a particular project. projects or at project level for a particular project.
To enable or disable Copilot suggestions globally, select the To enable or disable Copilot suggestions globally, select the