docs: Extract Common Pitfalls to dedicated documentation

- Created docs/COMMON_PITFALLS.md with all 72 pitfalls
- Organized by severity and category for better navigation
- Added quick reference table and cross-reference index
- Reduced copilot-instructions.md from 6,575 to 3,608 lines (45%)
- Kept Top 10 critical pitfalls in main instructions
- Preserved all git commits, dates, code examples
- Updated docs/README.md with references to new doc

Benefits:
- Faster AI agent context loading
- Easier maintenance and updates
- Better searchability by category
- Clear pattern recognition for similar issues
- Maintains comprehensive knowledge base

Co-authored-by: mindesbunister <32161838+mindesbunister@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-12-05 00:19:16 +00:00
parent bfe74df5df
commit 0c76bca1cc
3 changed files with 1580 additions and 3053 deletions

File diff suppressed because it is too large Load Diff

1493
docs/COMMON_PITFALLS.md Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -44,7 +44,7 @@ Obsolete verification checklists and documentation from previous development pha
**Debugging Issues:**
1. Search [bugs/](bugs/) directory for similar incidents
2. Review Common Pitfalls in `.github/copilot-instructions.md`
2. Review [COMMON_PITFALLS.md](COMMON_PITFALLS.md) for documented issues (72 pitfalls)
3. Check [deployments/](deployments/) for recent changes
4. Consult [analysis/DIAGNOSTIC_RESULTS_SUMMARY.md](analysis/DIAGNOSTIC_RESULTS_SUMMARY.md)
@@ -130,15 +130,16 @@ See [TRADING_GOALS.md](TRADING_GOALS.md) for complete financial roadmap ($106
**Documentation Mandate:**
- **EVERY git commit requires documentation update** - Code without docs = incomplete work
- See `.github/copilot-instructions.md` "DOCUMENTATION + GIT COMMIT: INSEPARABLE WORKFLOW"
- Common Pitfalls, new ENV variables, configuration changes → Document immediately
- Bug fixes → Add to Common Pitfalls with full incident details
- ENV variables, configuration changes → Document in copilot-instructions.md
- Bug fixes → Add to `docs/COMMON_PITFALLS.md` with full incident details
---
## 🔗 External References
- **Main Repository:** `/home/icke/traderv4/`
- **Configuration:** `.github/copilot-instructions.md` (6,400+ lines)
- **Configuration:** `.github/copilot-instructions.md` (3,600+ lines)
- **Common Pitfalls:** `docs/COMMON_PITFALLS.md` (72 documented issues)
- **Environment Variables:** `.env` (482 lines)
- **Database Schema:** `prisma/schema.prisma`
- **Primary Code:** `app/api/trading/`, `lib/trading/`, `lib/drift/`
@@ -148,8 +149,8 @@ See [TRADING_GOALS.md](TRADING_GOALS.md) for complete financial roadmap ($106
## 📞 Support
**For Issues:**
1. Check [bugs/](bugs/) for similar problems
2. Review Common Pitfalls in `.github/copilot-instructions.md`
1. Check [COMMON_PITFALLS.md](COMMON_PITFALLS.md) for documented issues (72 pitfalls)
2. Search [bugs/](bugs/) for similar problems
3. Consult [deployments/](deployments/) for recent changes
4. Search git history: `git log --grep="keyword"`