Skip to content

Commit 207d90b

Browse files
authored
Add more FAQs (#111)
* Add links to new developer guides * Add token usage tracking to workspace page * Add FAQs
1 parent 014575b commit 207d90b

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed

docs/about/faq.md

+63
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,66 @@ your client and the LLM it's communicating with.
1515
We are actively exploring additional integrations based on user feedback.
1616
[Join the community on Discord](https://discord.gg/stacklok) to let us know
1717
about your favorite AI coding tool!
18+
19+
In theory, any tool that supports one of CodeGate's provider API endpoints
20+
should work, however we have encountered many edge cases depending on how the AI
21+
assistants and agents format their prompts and expect their responses, so your
22+
mileage may vary.
23+
24+
### Don't AI coding tools already redact secrets for me?
25+
26+
It may be surprising to learn that AI coding tools don't redact secrets for you.
27+
Through packet captures and logging, we've seen these tools routinely sending
28+
secrets and PII to remote LLM providers as they collect file contents to use as
29+
context.
30+
31+
### Can I use CodeGate without an internet connection?
32+
33+
Yes, CodeGate can be used without an internet connection as long as you have a
34+
local LLM server running. CodeGate is designed to work with local providers like
35+
Ollama, LM Studio, and vLLM. Once you have downloaded the container image,
36+
CodeGate has no external dependencies and can be run entirely offline.
37+
38+
### How do I know if I'm running the latest version of CodeGate?
39+
40+
The CodeGate dashboard includes a version update check which will alert you if a
41+
new version is available. You can also check the latest version of CodeGate on
42+
our [GitHub Releases page](https://github.com/stacklok/codegate/releases). To
43+
upgrade, see the [upgrade instructions](../how-to/install.mdx#upgrade-codegate)
44+
in the installation guide.
45+
46+
### What kind of support is available for CodeGate?
47+
48+
We offer community support through
49+
[GitHub Issues](https://github.com/stacklok/codegate/issues) and our
50+
[Discord server](https://discord.gg/stacklok).
51+
52+
### How do I troubleshoot issues with CodeGate?
53+
54+
If you encounter issues with CodeGate, please check the following:
55+
56+
- Ensure you are using the latest version of CodeGate.
57+
- Check the container logs for any error messages or warnings. Run
58+
`docker logs codegate` to view the logs. You can also increase the logging
59+
verbosity by re-launching CodeGate with `CODEGATE_APP_LOG_LEVEL` set to `INFO`
60+
or `DEBUG` (see [advanced configuration](../how-to/configure.md)).
61+
- Search the [GitHub Issues](https://github.com/codegate/codegate/issues) for
62+
similar issues or report a new issue if you can't find a solution.
63+
- Join our [Discord server](https://discord.gg/stacklok) to ask for help from
64+
the community or the CodeGate team.
65+
66+
### Can I use CodeGate in a team environment?
67+
68+
Currently, CodeGate is designed to run on a single machine, but we are always
69+
eager to hear feedback about how you would like or expect to use CodeGate in a
70+
team environment. Please share your ideas/feedback in the
71+
[Feature Ideas section](https://github.com/stacklok/codegate/discussions/categories/feature-ideas)
72+
in the project's GitHub Discussions or jump into our
73+
[Discord server](https://discord.gg/stacklok)!
74+
75+
### Can I contribute to CodeGate?
76+
77+
Yes! CodeGate is an open-source project, and we welcome contributions from the
78+
community. You can contribute by reporting issues, submitting pull requests, or
79+
helping with documentation. Please check our
80+
[contributing guidelines](./contributing.md).

docs/development/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ in the main CodeGate GitHub repo.
1111
- [CLI commands and flags](https://github.com/stacklok/codegate/blob/main/docs/cli.md)
1212
- [Configuration system](https://github.com/stacklok/codegate/blob/main/docs/configuration.md)
1313
- [Logging system](https://github.com/stacklok/codegate/blob/main/docs/logging.md)
14+
- [Debugging clients](https://github.com/stacklok/codegate/blob/main/docs/debugging_clients.md)
15+
- [Workspaces](https://github.com/stacklok/codegate/blob/main/docs/workspaces.md)

docs/features/workspaces.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ Workspaces offer several key features:
3636
CodeGate security detections (alert history) are recorded in the active
3737
workspace, allowing you to track and review past interactions.
3838

39+
- **Token usage tracking**: CodeGate tracks LLM token usage per workspace,
40+
allowing you to monitor and analyze consumption across different contexts or
41+
projects. For example, this feature can help you manage costs by identifying
42+
high-usage workspaces or optimize API usage by adjusting prompts to reduce
43+
token consumption.
44+
3945
- **Isolation**: Configurations and data in one workspace do not affect others,
4046
providing clarity when reviewing your AI-assisted coding history and precision
4147
in tailoring your custom instructions.

0 commit comments

Comments
 (0)