Skip to content

Commit 4ceb25e

Browse files
authored
Merge pull request #63 from project-codeguard/docs/update_faq
Adding details around context window usage
2 parents 9d88eec + 4e56286 commit 4ceb25e

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

docs/faq.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,20 @@ This FAQ document provides clear, concise answers to help developers seamlessly
2626
---
2727
## Q: Will these rules consume a lot of the AI agent's **context window**?
2828

29-
**A:** No. The always-on rules are designed to be lightweight and efficient, and should not consume a lot of the AI agent's context window. The "glob" rules are designed to be applied only to the related file types specified in the rule.
29+
**A:** The always‑on rules are lightweight and have minimal impact on the AI agent’s context window. Glob‑scoped rules only apply to their matching file types. Below are Cursor examples: left, no rules; right, three always‑on rules enabled.
30+
31+
<p align="center">
32+
<img src="images/context-window-no-rules.png" alt="Cursor AI agent context window usage without Project CodeGuard rules" width="40%" style="display:inline-block; margin-right:2%;" />
33+
<img src="images/context-window-with-rules.png" alt="Cursor AI agent context window usage with Project CodeGuard rules enabled" width="40%" style="display:inline-block;" />
34+
</p>
35+
36+
<center>
37+
<sub>
38+
<b>Left:</b> Context window usage without any rules in place.<br>
39+
<b>Right:</b> Context window usage with three always-on rules enabled.
40+
</sub>
41+
</center>
42+
3043

3144
---
3245
## Q: What are the OWASP supplementary rules?
24.1 KB
Loading
46.8 KB
Loading

0 commit comments

Comments
 (0)