expense_snap

Documentation Index

Overview

This directory contains comprehensive documentation for the Expense Snap project.

Documents

Document Purpose Audience
API.md API reference for models, repositories, providers, services Developers
KNOWLEDGE_BASE.md Architecture, data flow, performance, troubleshooting Developers
POLISH_PLAN.md Polish phases 7-13 execution history (completed) Historical
File Location Purpose
PROJECT_INDEX.md Root AI-optimized codebase index (94% token reduction)
CLAUDE.md Root AI assistant instructions & code conventions
README.md Root Project overview & getting started
openspec/ Root Feature specifications
.serena/memories/ Root Cross-session context (Serena MCP)

For New Developers

  1. Read README.md for project overview
  2. Study KNOWLEDGE_BASE.md for architecture
  3. Reference API.md when coding

For AI Assistants

  1. Read PROJECT_INDEX.md first (mandatory)
  2. Check CLAUDE.md for conventions
  3. Reference openspec/ for feature specs

For Troubleshooting

  1. Check KNOWLEDGE_BASE.md#troubleshooting
  2. Review test files in test/ directory
  3. Check .serena/memories/ for session context

Maintenance

Documentation is maintained alongside code changes. When making significant changes:

  1. Update relevant docs in this directory
  2. Update PROJECT_INDEX.md if structure changes
  3. Update openspec/ if features change