Skip to content

MEMORY_BANK_INDEX.md

Latest commit

 

History

History
271 lines (210 loc) · 7.79 KB

MEMORY_BANK_INDEX.md

File metadata and controls

271 lines (210 loc) · 7.79 KB

📚 Memory Bank Index

This document indexes all memory bank files for easy reference.

Core Project Documentation

projectBrief.md

  • Project vision and purpose
  • Target users and scope
  • MVP vs Phase 2+ features
  • Success criteria and milestones
  • Read this first for project overview

systemPatterns.md

  • Architecture overview
  • Service layer design
  • API contract specifications
  • Data flow diagrams
  • Cache strategy
  • Database schema

decisions.md

  • Key architectural decisions
  • Technology choices and rationale
  • Trade-offs and alternatives considered
  • Justification for major decisions

techContext.md

  • Tech stack detailed breakdown
  • Language and framework versions
  • Library versions and dependencies
  • Performance characteristics
  • Scalability considerations

Progress & Status Tracking

progress.md

  • Phase-by-phase completion tracker
  • Task status (completed, in-progress, TODO)
  • Outstanding items with priority
  • Recent updates and dates
  • Update this regularly

development-status.md [NEW]

  • Comprehensive status report
  • Component implementation status
  • Test results summary
  • Architecture diagrams
  • Quality metrics
  • Read for current full status

Feature & Implementation Details

features.md

  • Complete feature list
  • MVP vs future features
  • Feature descriptions and use cases
  • Implementation status
  • Acceptance criteria

api-spec.md

  • API endpoint specifications
  • Request/response schemas
  • Error codes and messages
  • Rate limiting and quotas
  • Authentication (future)

ml-models.md

  • Optimization algorithms used
  • Maximum Sharpe ratio approach
  • Efficient frontier generation
  • Ledoit-Wolf covariance
  • Performance benchmarks

Testing & Quality

testing-strategy.md

  • Test pyramid structure
  • Unit test coverage targets
  • Integration test scope
  • E2E test scenarios
  • Performance testing approach
  • CI/CD pipeline requirements

Deployment & Operations

deployment.md

  • Deployment architecture
  • Environment configurations
  • Database setup and migration
  • Scaling strategy
  • Monitoring and logging
  • Disaster recovery

data-sources.md

  • Yahoo Finance integration
  • Data quality requirements
  • Historical data specifications
  • Real-time vs batch updates
  • Data refresh strategy

Active Context

activeContext.md

  • Current focus and priorities
  • Active work items
  • Immediate blockers
  • Assumptions and constraints
  • Context for current phase
  • Update before starting new phase

Frontend Details [NEW]

frontend-scaffolding.md

  • Frontend structure created
  • Component descriptions
  • Page specifications
  • API integration details
  • Styling and responsive design
  • Reference for frontend architecture

Root Level Project Files [NEW]

QUICKSTART.md

  • Get running in 2 minutes
  • Quick command reference
  • Troubleshooting guide
  • Key features overview
  • Start here for hands-on work

PHASE8_COMPLETION.md

  • Phase 8 summary and status
  • What was accomplished
  • File structure created
  • Features implemented
  • Next steps (Phase 9)
  • Read for Phase 8 context

IMPLEMENTATION_CHECKLIST.md

  • Phase-by-phase checklist (Phases 1-15)
  • Sub-tasks for each phase
  • Sample test cases
  • Current status dashboard
  • Future phases overview
  • Use to track progress

How to Use This Index

For New Team Members

  1. Start with projectBrief.md - Understand the vision
  2. Read systemPatterns.md - Learn the architecture
  3. Check progress.md - See what's done
  4. Open QUICKSTART.md - Start running code

For Feature Development

  1. Check features.md - Find your feature
  2. Review systemPatterns.md - Understand where it fits
  3. Look at api-spec.md - See API contract
  4. Check tests in relevant test files

For Debugging/Troubleshooting

  1. Consult QUICKSTART.md - Quick troubleshooting section
  2. Check techContext.md - Technology details
  3. Review deployment.md - Environment issues
  4. Look at testing-strategy.md - Test-related issues

For Deployment

  1. Read deployment.md - Full deployment guide
  2. Check data-sources.md - Data setup requirements
  3. Review testing-strategy.md - Pre-deployment testing

For Architecture Decisions

  1. Review decisions.md - Why each choice was made
  2. Check systemPatterns.md - How it's implemented
  3. Look at techContext.md - Technology context

File Update Guidelines

When to Update Files

Update progress.md:

  • After completing a task
  • When starting a new phase
  • When encountering blockers
  • When changing priorities
  • At least once per day during development

Update activeContext.md:

  • Before each work session
  • When switching contexts/tasks
  • When assumptions change
  • Before switching team members in

Update IMPLEMENTATION_CHECKLIST.md:

  • When completing a major phase
  • When adding/removing tasks
  • When re-prioritizing work

Create PHASE_N_COMPLETION.md:

  • When completing each major phase
  • Summarize what was accomplished
  • List files created/modified
  • Link to relevant documentation
  • Describe next steps

Document Organization Principles

  1. Separation of Concerns: Each document focuses on one aspect
  2. Cross-referencing: Links between related documents
  3. Versioning: Dates on changes to track evolution
  4. Actionability: Documents guide decisions and actions
  5. Completeness: Enough detail to implement without the author

Quick Document Access

Just started working here?

Need project overview?

Need current status?

Need architecture details?

Need to track progress?

Need to understand decisions?

Need API details?

Need deployment help?

Stats Summary

Type Count Files
Core Documentation 7 projectBrief, systemPatterns, decisions, techContext, features, api-spec, ml-models
Progress Tracking 2 progress.md, activeContext.md
Operations 4 testing-strategy, deployment, data-sources, frontend-scaffolding
Quick Reference 3 QUICKSTART, PHASE8_COMPLETION, IMPLEMENTATION_CHECKLIST
TOTAL 16 Documents

Last Updated

  • Date: 2025-12-13
  • Phase: 8 (Frontend Scaffolding Complete)
  • Status: ✅ Ready for Phase 9 (Local Integration Testing)

For questions about documents, see activeContext.md