fix: adds note for copilot docs #82
Conversation
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.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This isn't the intended behavior, and may be a bug. Having a file in context didn't previously break |
|
@danbarr Yeah I was probably a bit too quick with the PR, I found out shortly after that it was a bug. Is it worth adding a link to the bug issue number in this note, or shall we just close this PR in hopes that the bug gets fixed before many first time users of codegate realise? |
There was a problem hiding this comment.
Let's go ahead and add the note since Copilot's one of our most popular integrations. I suggested some updated wording. It would also be good to add this note to the Copilot Quickstart guide, in between here:
codegate-docs/docs/quickstart-copilot.mdx
Lines 97 to 100 in 59e3725
Enter `codegate version` in the Copilot chat to confirm that CodeGate is
intercepting Copilot traffic. CodeGate responds with its version number.
:::note
There is a [known issue](https://github.com/stacklok/codegate/issues/1061) with
`codegate` commands in Copilot chat if you have a file included in the context.
Close all open files or use the eye icon in the chat input to disable the
current file context, otherwise Copilot responds based on the file you have open
instead of returning the command result.
:::
## Explore CodeGate's key features
Co-authored-by: Dan Barr <[email protected]>
Co-authored-by: Dan Barr <[email protected]>
Signed-off-by: ChrisJBurns <[email protected]>
|
@danbarr Have committed your suggestions and added that extra note! 👍 |
|
@danbarr happy to merge when you are |
|
Oh I assumed you had permisisons to 😄 Merging now, thanks for pointing out this issue! |
|
@danbarr Oh, yes I did, I just didn't know if it was ok to merge incase there were things that had to happen first on public facing docs haha! So wanted to check with you first before I did |
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.