Skip to content

guides

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

guides

README.md

Guides Directory

Last Updated: November 11, 2025 Status: 🎉 WORLD-CLASS - Reorganized testing patterns + development tools Active Files: 11 (2 core + 9 subfolders) Structure: Professional category-based organization with clear semantic grouping

📚 Core Workflow Guides (Root Level)

⭐ Essential Reading (Start Here!)

  • DEVELOPER_WORKFLOW.md ⭐ - Complete development setup and daily workflows

    • Consolidates: DEVELOPMENT_SETUP.md, VSCODE_SETUP.md, QUICK_REFERENCE.md, AUTOMATION_GUIDE.md (key parts)
    • Initial setup, VS Code configuration, infrastructure, frontend/backend commands, quick reference
    • Your one-stop guide for daily development!

  • PULL_REQUEST_COMPLETE_GUIDE.md ⭐ - Complete PR workflow

    • Consolidates: PULL_REQUEST_GUIDE.md, MANUAL_PR_INSTRUCTIONS.md, CHECK_PRS.md, PRE_MERGE_CHECKLIST.md
    • PR creation, automated checks, code review, troubleshooting, best practices
    • Everything you need for successful PRs!

📂 Organized by Category

🧪 testing/ - Testing Patterns & Best Practices

Production-ready testing guides with battle-tested patterns:

  • frontend-testing-patterns.md - Session 79-89 comprehensive guide (3,026 lines, 88.84% coverage achievement)

    • AsyncMock pattern for React, Mathematical Indicator Testing (9 indicators proven), Canvas testing, WebSocket testing
    • 100% success rate across 121 frontend tests, cross-referenced with Pattern Library

  • external-api-testing-patterns.md - Session 77 backend testing guide (1,136 lines, 94.5% avg coverage)

    • create_mock_response() helper, async context managers, rate limiting, cache validation
    • Proven across 6 services (DataArchival, Crypto, Forex, Stock, Indices, News), 157 tests total

  • backend-coverage-best-practices.md - Session 69 coverage patterns (492 lines)

    • Branch coverage configuration, smart exclusions (11 patterns), AsyncMock for pytest
    • 23.02% → 97% coverage achievements, industry-standard practices

  • overview.md - Complete testing guide (consolidated from TESTING_GUIDE.md + integration.md)

    • Test organization, naming conventions, test types (unit/integration/E2E), Docker setup, CI/CD automation
    • Integration testing quick start, Docker troubleshooting, health endpoints, best practices

  • coverage.md - Test coverage baseline and targets

💎 quality/

Code quality standards and tools:

🏗️ infrastructure/

Database and service setup:

� architecture/

Project structure and optimization:

📦 Archive

Consolidated/obsolete guides moved to .archive/ (14 files archived):

Phase 2 (Core Consolidations):

  • ✅ PULL_REQUEST_GUIDE.md → PULL_REQUEST_COMPLETE_GUIDE.md
  • ✅ MANUAL_PR_INSTRUCTIONS.md → PULL_REQUEST_COMPLETE_GUIDE.md
  • ✅ CHECK_PRS.md → PULL_REQUEST_COMPLETE_GUIDE.md
  • ✅ PRE_MERGE_CHECKLIST.md → PULL_REQUEST_COMPLETE_GUIDE.md
  • ✅ DEVELOPMENT_SETUP.md → DEVELOPER_WORKFLOW.md
  • ✅ VSCODE_SETUP.md → DEVELOPER_WORKFLOW.md
  • ✅ DEPLOYMENT_GUIDE.md → See ../deployment/ folder

Phase 2.5 (Additional Optimizations):

  • ✅ PR_20_CHECKS_EXPLAINED.md → Archived (PR-specific)
  • ✅ PR_20_EXPLANATION.md → Archived (PR-specific)
  • ✅ PR_DESCRIPTION.md → Archived (PR-specific)
  • ✅ GITIGNORE_AUDIT_REPORT.md → Archived (one-off report)
  • ✅ VISUAL_REGRESSION_BASELINES.md → TESTING_GUIDE.md
  • ✅ QUICK_REFERENCE.md → DEVELOPER_WORKFLOW.md
  • ✅ AUTOMATION_GUIDE.md → DEVELOPER_WORKFLOW.md

Phase 3 (Session 89 - Guide Optimization - November 11, 2025):

  • ✅ FRONTEND_BUNDLE_ANALYSIS.md → /docs/plans/.archive/analysis/frontend-bundle-analysis-2025-11-03.md (historical performance baseline)

🔍 Quick Navigation

By Task:

By Role:

  • New developers: DEVELOPER_WORKFLOW.md → quality/standards.md → testing/TESTING_GUIDE.md
  • Contributors: PULL_REQUEST_COMPLETE_GUIDE.md → quality/overview.md
  • Maintainers: architecture/REPOSITORY_STRUCTURE.md → architecture/TECHNICAL_DEBT.md
  • DevOps: infrastructure/ folder → ../ci-cd/

📦 Archive

Consolidated/obsolete guides moved to .archive/ (14 files archived):

Phase 2 (Core Consolidations):

  • ✅ PULL_REQUEST_GUIDE.md → PULL_REQUEST_COMPLETE_GUIDE.md
  • ✅ MANUAL_PR_INSTRUCTIONS.md → PULL_REQUEST_COMPLETE_GUIDE.md
  • ✅ CHECK_PRS.md → PULL_REQUEST_COMPLETE_GUIDE.md
  • ✅ PRE_MERGE_CHECKLIST.md → PULL_REQUEST_COMPLETE_GUIDE.md
  • ✅ DEVELOPMENT_SETUP.md → DEVELOPER_WORKFLOW.md
  • ✅ VSCODE_SETUP.md → DEVELOPER_WORKFLOW.md
  • ✅ DEPLOYMENT_GUIDE.md → See ../deployment/ folder

Phase 2.5 (Additional Optimizations):

  • ✅ PR_20_CHECKS_EXPLAINED.md → Archived (PR-specific)
  • ✅ PR_20_EXPLANATION.md → Archived (PR-specific)
  • ✅ PR_DESCRIPTION.md → Archived (PR-specific)
  • ✅ GITIGNORE_AUDIT_REPORT.md → Archived (one-off report)
  • ✅ VISUAL_REGRESSION_BASELINES.md → testing/TESTING_GUIDE.md
  • ✅ QUICK_REFERENCE.md → DEVELOPER_WORKFLOW.md
  • ✅ AUTOMATION_GUIDE.md → DEVELOPER_WORKFLOW.md

🎯 Consolidation & Restructure Achievement

October 27, 2025 - Major Restructure Complete!

Results:

  • 📉 Files reduced: 25 → 12 active (52% reduction!)
  • � Better organization: 4 category subfolders created
  • �📦 Files archived: 14 guides consolidated or archived
  • 📝 Major consolidations: 2 comprehensive guides created
  • ✏️ Files renamed: 2 (REDIS_DOCKER_SETUP → REDIS_SETUP, POSTGRESQL_SETUP_GUIDE → POSTGRESQL_SETUP)
  • ✅ Professional structure: Clear categorization by function

Impact:

  • ✨ Clearer navigation - Organized by category (testing, quality, infrastructure, architecture)
  • 📚 Comprehensive guides - More context in fewer places
  • 🔍 Better discoverability - Related content grouped together
  • 🎯 Reduced maintenance - Fewer files to keep in sync
  • 🏗️ Scalable structure - Easy to add new guides to appropriate categories

📖 For complete documentation: See ../README.md for project-wide documentation index