mystiatech/Mai
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: establish fresh planning foundation with new features

Browse Source 
- Update PROJECT.md: Add Android, visualizer, and avatar to v1
- Update REQUIREMENTS.md: 99 requirements across 15 phases (fresh slate)
- Add comprehensive README.md with setup, architecture, and usage
- Add PROGRESS.md for Discord forum sharing
- Add .gitignore for Python/.venv and project artifacts
- Note: All development via Claude Code/OpenCode workflow
- Note: Python deps managed via .venv virtual environment

Core value: Mai is a real collaborator, not a tool. She learns from you,
improves herself, has boundaries and opinions, and becomes more *her* over time.

v1 includes: Model interface, Safety, Resources, Memory, Conversation,
CLI, Self-Improvement, Approval, Personality, Discord, Offline, Voice
Visualization, Avatar, Android App, Device Sync.
This commit is contained in:
Mai Development
2026-01-26 23:21:40 -05:00
parent 5dc7b98abf
commit 3f41adff75
5 changed files with 715 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
.planning/REQUIREMENTS.md
View File

@@ -92,19 +92,20 @@
**Out of scope for v1:**
- Web interface
- Mobile apps
- Multi-user support
- Cloud hosting
- Enterprise features
- Third-party integrations beyond Discord
- Plugin system
- API for external developers
- Cloud sync/backup
**Phase Boundary:**
- **v1 Focus:** Personal AI assistant for individual use
- **v1 Focus:** Personal AI assistant for desktop and Android with visual presence
- **Local First:** All data stored locally, no cloud dependencies
- **Privacy:** User data never leaves local system
- **Simplicity:** Clear separation of concerns across phases
- **Cross-device:** Sync between desktop and Android instances
- **Visual:** Avatar and voice visualization for richer interaction
---
@@ -244,15 +245,58 @@
| OFFLINE-06 | Phase 11 | Pending |
| OFFLINE-07 | Phase 11 | Pending |
### Voice Visualization (VISUAL)
| Requirement | Phase | Status | Implementation Notes |
|------------|-------|--------|-------------------|
| VISUAL-01 | Phase 12 | Pending |
| VISUAL-02 | Phase 12 | Pending |
| VISUAL-03 | Phase 12 | Pending |
| VISUAL-04 | Phase 12 | Pending |
| VISUAL-05 | Phase 12 | Pending |
### Desktop Avatar (AVATAR)
| Requirement | Phase | Status | Implementation Notes |
|------------|-------|--------|-------------------|
| AVATAR-01 | Phase 13 | Pending |
| AVATAR-02 | Phase 13 | Pending |
| AVATAR-03 | Phase 13 | Pending |
| AVATAR-04 | Phase 13 | Pending |
| AVATAR-05 | Phase 13 | Pending |
| AVATAR-06 | Phase 13 | Pending |
### Android App (ANDROID)
| Requirement | Phase | Status | Implementation Notes |
|------------|-------|--------|-------------------|
| ANDROID-01 | Phase 14 | Pending |
| ANDROID-02 | Phase 14 | Pending |
| ANDROID-03 | Phase 14 | Pending |
| ANDROID-04 | Phase 14 | Pending |
| ANDROID-05 | Phase 14 | Pending |
| ANDROID-06 | Phase 14 | Pending |
| ANDROID-07 | Phase 14 | Pending |
| ANDROID-08 | Phase 14 | Pending |
| ANDROID-09 | Phase 14 | Pending |
| ANDROID-10 | Phase 14 | Pending |
### Device Synchronization (SYNC)
| Requirement | Phase | Status | Implementation Notes |
|------------|-------|--------|-------------------|
| SYNC-01 | Phase 15 | Pending |
| SYNC-02 | Phase 15 | Pending |
| SYNC-03 | Phase 15 | Pending |
| SYNC-04 | Phase 15 | Pending |
| SYNC-05 | Phase 15 | Pending |
| SYNC-06 | Phase 15 | Pending |
---
## Validation
- Total v1 requirements: **74**
- Mapped to phases: **74**
- Total v1 requirements: **99** (74 core + 25 new features)
- Mapped to phases: **99**
- Unmapped: **0** ✓
- Coverage: **10100%**
- Coverage: **100%**
---
*Requirements defined: 2026-01-24*
*Phase 5 conversation engine completed: 2026-01-26*
*Last updated: 2026-01-26 - reset to fresh slate with Android, visualizer, and avatar features*