ilia
7c633a02ed
- Added .cursorrules for project guidelines and context - Created README.md for project overview and goals - Established ARCHITECTURE.md for architectural documentation - Set up tickets directory with initial ticket management files - Included .gitignore to manage ignored files and directories This commit lays the foundation for the Atlas project, ensuring a clear structure for development and collaboration.
94 lines
3.2 KiB
Markdown
94 lines
3.2 KiB
Markdown
# Quick Start Guide
|
|
|
|
## Overview
|
|
|
|
This project has **47 tickets** organized across 5 parallel tracks. All tickets are currently in `backlog/` and ready to be moved to `todo/` as you start working on them.
|
|
|
|
## Getting Started
|
|
|
|
1. **Review the tickets summary**: See `TICKETS_SUMMARY.md` for an overview
|
|
2. **Start with Milestone 1**: Foundation and surveys
|
|
3. **Move tickets as you work**: `backlog/` → `todo/` → `in-progress/` → `review/` → `done/`
|
|
|
|
## Recommended Starting Order
|
|
|
|
### Phase 1: Foundation (Week 1)
|
|
Move these to `todo/` first:
|
|
- TICKET-002: Define Project Repos and Structure
|
|
- TICKET-003: Document Privacy Policy and Safety Constraints
|
|
- TICKET-004: High-Level Architecture Document
|
|
|
|
### Phase 2: Parallel Surveys (Week 1-2)
|
|
These can be done in parallel:
|
|
- TICKET-005: Evaluate Wake-Word Engine
|
|
- TICKET-009: Select ASR Engine
|
|
- TICKET-013: Evaluate TTS Options
|
|
- TICKET-017: Survey LLM Models
|
|
- TICKET-018: LLM Capacity Assessment
|
|
- TICKET-028: Learn MCP Concepts
|
|
|
|
### Phase 3: Model Selection (Week 2)
|
|
- TICKET-019: Select Work Agent Model (4080)
|
|
- TICKET-020: Select Family Agent Model (1050)
|
|
|
|
### Phase 4: Implementation (Week 3+)
|
|
Start implementing based on selected technologies.
|
|
|
|
## Ticket Status Workflow
|
|
|
|
```
|
|
backlog/ → todo/ → in-progress/ → review/ → done/
|
|
```
|
|
|
|
1. **backlog/**: Future work, not yet started
|
|
2. **todo/**: Ready to work on (dependencies met)
|
|
3. **in-progress/**: Currently being worked on
|
|
4. **review/**: Complete, awaiting review/testing
|
|
5. **done/**: Approved and merged
|
|
|
|
## Using with Vibe Kanban
|
|
|
|
1. Import tickets into Vibe Kanban using ticket IDs (TICKET-002, etc.)
|
|
2. Tag tickets by track: Voice I/O, LLM Infra, Tools/MCP, Clients/UI, Safety/Memory
|
|
3. Tag tickets by milestone: M1, M2, M3, M4
|
|
4. Keep ticket files in sync with kanban board status
|
|
5. Reference ticket IDs in commits: `git commit -m "TICKET-002: Define repo structure"`
|
|
|
|
## Parallel Work Opportunities
|
|
|
|
Many tickets can be worked on simultaneously:
|
|
|
|
- **Voice I/O track**: Independent of LLM and MCP
|
|
- **LLM Infra track**: Can proceed after model selection
|
|
- **MCP Tools track**: Can start with minimal server, add tools incrementally
|
|
- **Clients/UI track**: Can mock APIs early, integrate later
|
|
- **Safety/Memory track**: Can design early, implement after MVP
|
|
|
|
## Critical Path for MVP
|
|
|
|
For fastest path to working MVP:
|
|
|
|
1. Foundation (TICKET-002, TICKET-003, TICKET-004)
|
|
2. Technology selection (TICKET-005, TICKET-009, TICKET-013, TICKET-019, TICKET-020)
|
|
3. MCP foundation (TICKET-028, TICKET-029)
|
|
4. Voice stack (TICKET-006, TICKET-010, TICKET-014)
|
|
5. LLM servers (TICKET-021, TICKET-022)
|
|
6. MCP integration (TICKET-030)
|
|
7. Core tools (TICKET-031, TICKET-034)
|
|
8. Phone client (TICKET-039)
|
|
9. End-to-end testing
|
|
|
|
## Tips
|
|
|
|
- **Read dependencies**: Each ticket lists its dependencies
|
|
- **Start small**: Begin with evaluations and prototypes
|
|
- **Iterate**: Don't wait for perfection - get MVP working first
|
|
- **Document decisions**: Update ARCHITECTURE.md as you make choices
|
|
- **Test early**: Test each component as you build it
|
|
|
|
## Questions?
|
|
|
|
- See `TICKETS_SUMMARY.md` for detailed breakdown
|
|
- See `TICKET_TEMPLATE.md` for ticket format
|
|
- See `README.md` in tickets/ for workflow details
|