| # Project Docs |
|
|
| This folder is the project memory. Use it before asking Codex to make larger changes. |
|
|
| ## Start Here |
|
|
| - [TASKS.md](TASKS.md) - checklist of hackathon tasks and subtasks. |
| - [IMPLEMENTATION_STATUS.md](IMPLEMENTATION_STATUS.md) - what is done, partial, or not started. |
| - [PRD_IMPLEMENTATION_MATRIX.md](PRD_IMPLEMENTATION_MATRIX.md) - exact PRD/ext implementation coverage. |
| - [ACCEPTANCE_CRITERIA.md](ACCEPTANCE_CRITERIA.md) - proof required before marking work done. |
| - [ROADMAP.md](ROADMAP.md) - hackathon path versus long-term PRD vision. |
| - [ROADMAP_V2_CRITICAL_IMPROVEMENT_PLAN.md](ROADMAP_V2_CRITICAL_IMPROVEMENT_PLAN.md) - hard |
| judge-oriented critique and second roadmap. |
| - [TEMPLATE_HOWTO.md](TEMPLATE_HOWTO.md) - how to build new domain apps from this template. |
| - [PLANT_DISCOVERY_APP_PLAN.md](PLANT_DISCOVERY_APP_PLAN.md) - detailed checklist for the first |
| reference app. |
| - [PLANT_MODEL_AND_TRAINING_HOWTO.md](PLANT_MODEL_AND_TRAINING_HOWTO.md) - model modes and |
| adapter training path for Plant Discovery. |
| - [PLANT_MODEL_AND_TRAINING_HOWTO.md](PLANT_MODEL_AND_TRAINING_HOWTO.md) - how Plant Discovery |
| uses OpenBMB MiniCPM-V and how to train an adapter. |
| - [USAGE.md](USAGE.md) - how to install, run, and use the app. |
| - [ARCHITECTURE.md](ARCHITECTURE.md) - how the code is organized and how pieces connect. |
| - [EXTENDING.md](EXTENDING.md) - how to add models, tabs, services, and features later. |
| - [HACKATHON_SUBMISSION.md](HACKATHON_SUBMISSION.md) - story, demo flow, video script, and submission checklist. |
|
|
| ## Source PRDs |
|
|
| - [HF_PRD_v1.md](../HF_PRD_v1.md) - main technical PRD. |
| - [HF_PRD_ext.md](../HF_PRD_ext.md) - planned extensions. |
|
|
| The PRDs describe the full vision. The task and status docs describe what is actually implemented |
| or planned for the hackathon MVP. |
|
|
