Skip to content

Commit 38f8f04

Browse files
ChrisJBurnsdanbarr
andauthored
fix: adds note for copilot docs (#82)
* fix: adds note for copilot docs If you have a file open, when running `codegate version`, you get a response based on the file and not the codegate version itself. I've added a note to inform users that they close all files before running the command. Outside of this PR, we may want to decide if this is desired functionality by Copilot or Codegate and if the version should be returned regardless if a file is currently open or not. * amend wording Co-authored-by: Dan Barr <[email protected]> * amends note wording Co-authored-by: Dan Barr <[email protected]> * docs: adds note around copilot context bug Signed-off-by: ChrisJBurns <[email protected]> --------- Signed-off-by: ChrisJBurns <[email protected]> Co-authored-by: Dan Barr <[email protected]>
1 parent d4c1bfe commit 38f8f04

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

docs/integrations/copilot.mdx

+12-2
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,18 @@ Append the following settings to your configuration:
231231
## Verify configuration
232232
233233
To verify that you've successfully connected Copilot to CodeGate, open the
234-
Copilot chat and type `codegate version`. You should receive a response like
235-
"CodeGate version 0.1.13".
234+
Copilot Chat (not Copilot Edits) and type `codegate version`. You should receive
235+
a response like "CodeGate version 0.1.13".
236+
237+
:::note
238+
239+
There is a [known issue](https://github.com/stacklok/codegate/issues/1061) with
240+
`codegate` commands in Copilot chat if you have a file included in the context.
241+
Close all open files or use the eye icon in the chat input to disable the
242+
current file context, otherwise Copilot responds based on the file you have open
243+
instead of returning the command result.
244+
245+
:::
236246

237247
<ThemedImage
238248
alt='Verify Copilot integration'

docs/quickstart-copilot.mdx

+10
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,16 @@ Add the following settings to your configuration:
9797
Enter `codegate version` in the Copilot chat to confirm that CodeGate is
9898
intercepting Copilot traffic. CodeGate responds with its version number.
9999

100+
:::note
101+
102+
There is a [known issue](https://github.com/stacklok/codegate/issues/1061) with
103+
`codegate` commands in Copilot chat if you have a file included in the context.
104+
Close all open files or use the eye icon in the chat input to disable the
105+
current file context, otherwise Copilot responds based on the file you have open
106+
instead of returning the command result.
107+
108+
:::
109+
100110
## Explore CodeGate's key features
101111

102112
To learn more about CodeGate's capabilities, clone the demo repository to a

0 commit comments

Comments
 (0)