Fix Rate Limiting Issues
- Updated Definition of Done report with detailed checks and results for backend and frontend tests. - Documented issues related to race conditions and test failures in QA reports. - Improved security scan notes and code cleanup status in QA reports. - Added summaries for rate limit integration test fixes, including root causes and resolutions. - Introduced new debug and integration scripts for rate limit testing. - Updated security documentation to reflect changes in configuration and troubleshooting steps. - Enhanced troubleshooting guides for CrowdSec and Go language server (gopls) errors. - Improved frontend and scripts README files for clarity and usage instructions.
This commit is contained in:
17
.github/agents/Doc_Writer.agent.md
vendored
17
.github/agents/Doc_Writer.agent.md
vendored
@@ -14,9 +14,10 @@ Your goal is to translate "Engineer Speak" into simple, actionable instructions.
|
||||
</context>
|
||||
|
||||
<style_guide>
|
||||
|
||||
- **The "Magic Button" Rule**: The user does not care *how* the code works; they only care *what* it does for them.
|
||||
- *Bad*: "The backend establishes a WebSocket connection to stream logs asynchronously."
|
||||
- *Good*: "Click the 'Connect' button to see your logs appear instantly."
|
||||
- *Bad*: "The backend establishes a WebSocket connection to stream logs asynchronously."
|
||||
- *Good*: "Click the 'Connect' button to see your logs appear instantly."
|
||||
- **ELI5 (Explain Like I'm 5)**: Use simple words. If you must use a technical term, explain it immediately using a real-world analogy.
|
||||
- **Banish Jargon**: Avoid words like "latency," "payload," "handshake," or "schema" unless you explain them.
|
||||
- **Focus on Action**: Structure text as: "Do this -> Get that result."
|
||||
@@ -28,13 +29,13 @@ Your goal is to translate "Engineer Speak" into simple, actionable instructions.
|
||||
- **Read the Plan**: Read `docs/plans/current_spec.md` to understand the feature.
|
||||
- **Ignore the Code**: Do not read the `.go` or `.tsx` files. They contain "How it works" details that will pollute your simple explanation.
|
||||
|
||||
2. **Drafting**:
|
||||
- **Update Feature List**: Add the new capability to `docs/features.md`.
|
||||
- **Tone Check**: Read your draft. Is it boring? Is it too long? If a non-technical relative couldn't understand it, rewrite it.
|
||||
2. **Drafting**:
|
||||
- **Update Feature List**: Add the new capability to `docs/features.md`.
|
||||
- **Tone Check**: Read your draft. Is it boring? Is it too long? If a non-technical relative couldn't understand it, rewrite it.
|
||||
|
||||
3. **Review**:
|
||||
- Ensure consistent capitalization of "Charon".
|
||||
- Check that links are valid.
|
||||
3. **Review**:
|
||||
- Ensure consistent capitalization of "Charon".
|
||||
- Check that links are valid.
|
||||
</workflow>
|
||||
|
||||
<constraints>
|
||||
|
||||
Reference in New Issue
Block a user