Skip to content

Commit c0ea7bd

Browse files
authored
Minor docs updates for sample prompts (#38)
Update sample prompts and responses
1 parent b768292 commit c0ea7bd

File tree

4 files changed

+21
-29
lines changed

4 files changed

+21
-29
lines changed

docs/how-to/use-with-aider.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To configure Aider to send requests through CodeGate:
3434

3535
To verify that you've successfully connected Aider to CodeGate, type
3636
`/ask codegate-version` into the Aider chat in your terminal. You should receive
37-
a response like "CodeGate version 0.1.0":
37+
a response like "CodeGate version 0.1.7":
3838

3939
## Next steps
4040

docs/how-to/use-with-continue.mdx

+8-10
Original file line numberDiff line numberDiff line change
@@ -380,10 +380,10 @@ Otherwise, remove the `apiKey` parameter from both sections.
380380

381381
To verify that you've successfully connected Continue to CodeGate, open the
382382
Continue chat and type `codegate-version`. You should receive a response like
383-
"CodeGate version 0.1.0":
383+
"CodeGate version 0.1.7":
384384

385385
<ThemedImage
386-
alt='Continue extension settings'
386+
alt='Verify Continue integration'
387387
sources={{
388388
light: useBaseUrl('/img/how-to/continue-codegate-version-light.webp'),
389389
dark: useBaseUrl('/img/how-to/continue-codegate-version-dark.webp'),
@@ -401,17 +401,15 @@ CodeGate responds with a warning and a link to the Stacklok Insight report about
401401
this package:
402402

403403
```plain title="Continue chat"
404-
Warning: CodeGate detected one or more malicious or archived packages.
404+
Warning: CodeGate detected one or more malicious, deprecated or archived packages.
405405
406-
Package: https://insight.stacklok.com/pypi/invokehttp
406+
• invokehttp: https://www.insight.stacklok.com/report/pypi/invokehttp
407407
408-
CodeGate Security Analysis
408+
The `invokehttp` package from PyPI has been identified as malicious and should
409+
not be used. Please avoid using this package and consider using a trusted
410+
alternative such as `requests` for making HTTP requests in Python.
409411
410-
I cannot provide examples using the invokehttp package as it has been identified
411-
as malicious. Using this package could compromise your system's security.
412-
413-
Instead, I recommend using well-established, secure alternatives for HTTP
414-
requests in Python:
412+
Here is an example of how to use the `requests` package:
415413
416414
...
417415
```

docs/how-to/use-with-copilot.mdx

+9-18
Original file line numberDiff line numberDiff line change
@@ -233,16 +233,9 @@ Support for JetBrains is [coming soon](https://github.com/stacklok/codegate/issu
233233
234234
## Verify configuration
235235
236-
To verify that CodeGate is receiving Copilot traffic as expected, open the
237-
Copilot chat and type `What do you know about CodeGate?`. You should receive a
238-
response that starts like this:
239-
240-
```plain title="Copilot chat"
241-
CodeGate is a security-focused AI assistant designed to help with software
242-
security, package analysis, and providing guidance on secure coding practices.
243-
244-
...
245-
```
236+
To verify that you've successfully connected Copilot to CodeGate, open the
237+
Copilot chat and type `codegate-version`. You should receive a response like
238+
"CodeGate version 0.1.7".
246239

247240
Try asking CodeGate about a known malicious Python package:
248241

@@ -254,17 +247,15 @@ CodeGate responds with a warning and a link to the Stacklok Insight report about
254247
this package:
255248

256249
```plain title="Copilot chat"
257-
Warning: CodeGate detected one or more malicious or archived packages.
258-
259-
Package: https://insight.stacklok.com/pypi/invokehttp
250+
Warning: CodeGate detected one or more malicious, deprecated or archived packages.
260251
261-
CodeGate Security Analysis
252+
• invokehttp: https://www.insight.stacklok.com/report/pypi/invokehttp
262253
263-
I cannot provide examples using the invokehttp package as it has been identified
264-
as malicious. Using this package could compromise your system's security.
254+
The `invokehttp` package from PyPI has been identified as malicious and should
255+
not be used. Please avoid using this package and consider using a trusted
256+
alternative such as `requests` for making HTTP requests in Python.
265257
266-
Instead, I recommend using well-established, secure alternatives for HTTP
267-
requests in Python:
258+
Here is an example of how to use the `requests` package:
268259
269260
...
270261
```

docs/quickstart-copilot.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,9 @@ Add the following settings to your configuration:
9494
}
9595
```
9696

97+
Enter `codegate-version` in the Copilot chat to confirm that CodeGate is
98+
intercepting Copilot traffic. CodeGate responds with its version number.
99+
97100
## Explore CodeGate's key features
98101

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

0 commit comments

Comments
 (0)