docs: Add mandatory rule #5 - CHECK DOCUMENTATION FIRST before suggestions
- New IRON-CLAD RULE: Always search docs before making suggestions or asking questions - Purpose: Prevent wasting user time with already-answered questions - Examples: TradingView rate limits, roadmap features, known bugs, configuration - Workflow: Read request → Search docs → Check if answered → THEN respond - Applies to: Features, bugs, config, architecture, deployment, troubleshooting - Red flags: User says 'we already documented this' or 'check docs first' - Why: User spent months documenting comprehensively, 'NOTHING gets lost' principle - Impact: Respect user's documentation effort, save time = save money in financial system Files modified: - .github/copilot-instructions.md (line ~103-150, added Rule #5 with examples and workflow)
This commit is contained in:
43
.github/copilot-instructions.md
vendored
43
.github/copilot-instructions.md
vendored
@@ -101,6 +101,49 @@ User is building from $901 → $100,000+ with this system. Every bug costs money
|
||||
|
||||
**Declaring something "working" without verification = causing financial loss**
|
||||
|
||||
**5. ALWAYS CHECK DOCUMENTATION BEFORE MAKING SUGGESTIONS**
|
||||
|
||||
This is MANDATORY. This is NOT negotiable. DO NOT waste user's time with questions already answered in documentation.
|
||||
|
||||
**Before making ANY suggestion or asking ANY question:**
|
||||
- ✅ Check `.github/copilot-instructions.md` (THIS FILE - contains system knowledge, patterns, pitfalls)
|
||||
- ✅ Check `docs/README.md` (Documentation hub with organized categories)
|
||||
- ✅ Check main `README.md` (Live system status and configuration)
|
||||
- ✅ Search `docs/` subdirectories for specific topics (setup, architecture, bugs, roadmaps, guides)
|
||||
- ✅ Grep search for keywords related to the topic
|
||||
- ✅ Check Common Pitfalls section (bugs #1-71) for known issues
|
||||
|
||||
**Examples of WASTING USER TIME (DO NOT DO THIS):**
|
||||
- ❌ Asking about TradingView rate limits when `docs/HELIUS_RATE_LIMITS.md` exists
|
||||
- ❌ Suggesting features already documented in roadmaps
|
||||
- ❌ Asking about configuration when ENV variables documented
|
||||
- ❌ Proposing solutions to bugs already fixed (check Common Pitfalls)
|
||||
- ❌ Questions about architecture already explained in docs
|
||||
|
||||
**Correct Workflow:**
|
||||
1. Read user request
|
||||
2. **SEARCH DOCUMENTATION FIRST** (copilot-instructions.md + docs/ directory)
|
||||
3. Check if question is already answered
|
||||
4. Check if suggestion is already implemented
|
||||
5. Check if issue is already documented
|
||||
6. **ONLY THEN** make suggestions or ask questions
|
||||
|
||||
**Why This Matters:**
|
||||
- User has spent MONTHS documenting this system comprehensively
|
||||
- Asking clarified questions = disrespecting user's documentation effort
|
||||
- "NOTHING gets lost" is the project principle - USE the documentation
|
||||
- This is a financial system - wasting time = wasting money
|
||||
- User expects AI to be KNOWLEDGEABLE, not forgetful
|
||||
|
||||
**Red Flags Indicating You Didn't Check Docs:**
|
||||
- User responds: "we already have this documented"
|
||||
- User responds: "check the docs first"
|
||||
- User responds: "this is in Common Pitfalls"
|
||||
- User responds: "read the roadmap"
|
||||
- User has to point you to existing documentation
|
||||
|
||||
**This rule applies to EVERYTHING:** Features, bugs, configuration, architecture, deployment, troubleshooting, optimization, analysis.
|
||||
|
||||
---
|
||||
|
||||
## 📋 MANDATORY: ROADMAP MAINTENANCE - NO EXCEPTIONS
|
||||
|
||||
Reference in New Issue
Block a user