aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2023-10-18 16:53:07 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2023-10-19 11:32:33 +0000
commit6ae4d71a1b1e4095d7736cb3186609a16868b883 (patch)
treec97a9c355c21b7f5268c168d2db0f8d9c70dd07c
parent720a77e0c0f13156ade37b76ca0f2ed1dee664e2 (diff)
Doc: Update GitHub Copilot docs
- Change link to Neovim plugin installation to point to the Readme.md - Add instructions for macOS users for finding the About Plugins and Preferences (using the \preferences macro) - Describe proxy settings - Fix a changed check box name Fixes: QTCREATORBUG-29734 Fixes: QTCREATORBUG-29613 Task-number: QTCREATORBUG-29392 Change-Id: I2b392e805322fd95a7b87295756d5df76015bbbc Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
-rw-r--r--doc/qtcreator/images/qtcreator-preferences-copilot.webpbin8724 -> 10032 bytes
-rw-r--r--doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc39
2 files changed, 28 insertions, 11 deletions
diff --git a/doc/qtcreator/images/qtcreator-preferences-copilot.webp b/doc/qtcreator/images/qtcreator-preferences-copilot.webp
index b98f74e43d..48df99f87b 100644
--- a/doc/qtcreator/images/qtcreator-preferences-copilot.webp
+++ b/doc/qtcreator/images/qtcreator-preferences-copilot.webp
Binary files differ
diff --git a/doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc b/doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc
index 62f0f72da6..1f30da9120 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-copilot.qdoc
@@ -26,9 +26,9 @@
\list
\li An active \l{https://docs.github.com/en/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot}
{GitHub Copilot subscription}.
- \li GitHub Copilot Neovim plugin installed, as described in
- \l{https://docs.github.com/en/copilot/getting-started-with-github-copilot?tool=neovim}
- {About GitHub Copilot and Neovim}.
+ \li GitHub Copilot Neovim plugin installed (requires Node.js), as described in
+ \l{https://github.com/github/copilot.vim/blob/release/README.md}
+ {Copilot.vim/Readme.md}.
\endlist
\section1 Enabling the Copilot Plugin
@@ -36,8 +36,9 @@
To enable the Copilot plugin:
\list 1
- \li Select \uicontrol Help > \uicontrol {About Plugins} >
- \uicontrol Utilities > \uicontrol Copilot to enable the plugin.
+ \li Select \uicontrol Help (or \uicontrol {\QC} on \macos) >
+ \uicontrol {About Plugins} > \uicontrol Utilities >
+ \uicontrol Copilot to enable the plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
@@ -56,17 +57,33 @@
\li In the \uicontrol {Node.js path} field, enter the full path to the
Node.js executable.
\li In the \uicontrol {Path to agent.js} field, enter the path to
- agent.js in the Copilot Neovim plugin.
- \li Select the \uicontrol {Request completions automatically} checkbox to
- receive suggestions for the current text cursor position when you
- make changes.
+ agent.js in the Copilot Neovim plugin installation folder.
+ \li Select the \uicontrol {Auto request} check box to receive suggestions
+ for the current text cursor position when you make changes.
+ \li Select the \uicontrol {Use proxy} check box to use a proxy server to
+ connect to Copilot servers.
+ \li In the \uicontrol {Proxy host} field, enter the host name of the
+ proxy server.
+ \li In the \uicontrol {Proxy port} field, enter the port number of the
+ proxy server.
+ \li Select the \uicontrol {Reject unauthorized} check box to prevent the
+ security risk presented by accepting unauthorized certificates from
+ the proxy server.
+ \li In the \uicontrol {Proxy user} field, enter the user name to
+ authenticate to the proxy server.
+ \li Select the \uicontrol {Save proxy password} check box to save the
+ password to authenticate to the proxy server.
+ \note The password is saved insecurely.
+ \li In the \uicontrol {Proxy password} field, enter the password to save.
+ To see the password as you type, select the \inlineimage icons/original-size.png
+ button.
\endlist
\section1 Receiving Suggestions
When you write code in the \l {Working in Edit Mode}{Edit} mode and
- \uicontrol {Request completions automatically} is enabled, Copilot
- automatically makes suggestions when you type.
+ \uicontrol {Auto request} is enabled, Copilot automatically makes
+ suggestions when you type.
\image qtcreator-copilot.gif {Receiving suggestions from Copilot in the editor}