Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 1.12 KB

File metadata and controls

52 lines (41 loc) · 1.12 KB

📁 File Guide - Multi-Agent Study Assistant

Quick Navigation

🚀 Start Here

  • README.md - Main documentation
  • QUICKSTART.md - 5-minute setup guide
  • setup.sh - Automated setup script

💻 Core Code

  • app.py - Streamlit web interface
  • study_agents.py - AI agent definitions
  • agent_handler.py - Orchestration logic
  • rag_helper.py - RAG functionality
  • config.py - Configuration manager
  • prompts.yaml - Agent prompts & config

📚 Documentation

  • ARCHITECTURE.md - Technical details
  • PROJECT_SUMMARY.md - Complete overview
  • FILE_GUIDE.md - This file

⚙️ Configuration

  • pyproject.toml - Dependencies (uv)
  • requirements.txt - Dependencies (pip)
  • .env.example - Environment template
  • .gitignore - Git ignore rules

🎯 Reading Order by Goal

Quick Start

  1. QUICKSTART.md
  2. Run setup.sh
  3. Edit .env
  4. Run app.py

Understand Project

  1. README.md
  2. PROJECT_SUMMARY.md
  3. ARCHITECTURE.md

Customize

  1. prompts.yaml (easiest)
  2. study_agents.py
  3. agent_handler.py

Deploy

  1. README.md
  2. requirements.txt
  3. setup.sh