chore: organize documentation structure for monorepo
- Create /docs structure (microdao, daarion, agents) - Organize 61 cursor technical docs - Add README files for each category - Copy key documents to public categories - Add GitHub setup instructions and scripts
This commit is contained in:
122
README.md
Normal file
122
README.md
Normal file
@@ -0,0 +1,122 @@
|
||||
# MicroDAO MVP
|
||||
|
||||
Приватна мережа ШІ-агентів для малих спільнот (5-50 членів)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Швидкий старт
|
||||
|
||||
```bash
|
||||
# Встановити залежності
|
||||
npm install
|
||||
|
||||
# Запустити dev server
|
||||
npm run dev
|
||||
|
||||
# Відкрити в браузері
|
||||
http://localhost:3000/onboarding
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📍 Де знаходиться проєкт
|
||||
|
||||
**Повний шлях:**
|
||||
```
|
||||
/Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
```
|
||||
|
||||
**Швидкий доступ:**
|
||||
- Символічне посилання: `~/Desktop/MicroDAO-QuickAccess`
|
||||
- Spotlight: `⌘ + Space` → "MicroDAO 3"
|
||||
|
||||
**Для посилань в чатах:**
|
||||
```
|
||||
Проєкт: /Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
Документація: docs/cursor/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 Документація
|
||||
|
||||
### Для Cursor AI
|
||||
Повна документація знаходиться в `docs/cursor/` (17+ документів):
|
||||
|
||||
- **Фундамент:** 00-07 (overview, product, architecture, API, UI/UX, standards, tasks, tests)
|
||||
- **Агентська система:** 08-13 (onboarding, evolution, UI, LLM, runtime, memory)
|
||||
- **Модулі:** 14, 21-22 (messenger, interface, tasks)
|
||||
|
||||
**Навігація:** `docs/cursor/README.md`
|
||||
|
||||
### Швидкий контекст
|
||||
- `PROJECT_CONTEXT.md` — Швидкий доступ до ключових інформацій
|
||||
- `QUICK_START.md` — Інструкції запуску
|
||||
- `PROJECT_INFO.md` — Детальна інформація про проєкт
|
||||
|
||||
---
|
||||
|
||||
## 🗂️ Структура
|
||||
|
||||
```
|
||||
MicroDAO 3/
|
||||
├── docs/
|
||||
│ ├── cursor/ # Документація для Cursor
|
||||
│ └── microdao_project_notes.ipynb
|
||||
├── src/
|
||||
│ ├── api/ # API клієнти
|
||||
│ ├── components/ # React компоненти
|
||||
│ ├── hooks/ # React hooks
|
||||
│ ├── pages/ # Сторінки
|
||||
│ └── types/ # TypeScript типи
|
||||
├── package.json
|
||||
└── vite.config.ts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Статус проєкту
|
||||
|
||||
### ✅ Завершено
|
||||
- Документація для Cursor (17 документів)
|
||||
- Онбординг (6 кроків)
|
||||
- API інтеграція
|
||||
- Git репозиторій
|
||||
|
||||
### ⏳ В процесі
|
||||
- Agent-Only Interface
|
||||
- LLM інтеграція
|
||||
- Система пам'яті
|
||||
|
||||
### 📋 Заплановано
|
||||
- Projects Agent (15)
|
||||
- Follow-ups Agent (16)
|
||||
- Co-Memory Agent (17)
|
||||
- Governance Agent (18)
|
||||
- Notifications Agent (19)
|
||||
- Integrations Agent (20)
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Технології
|
||||
|
||||
- **Frontend:** React 18, TypeScript, Vite, Tailwind CSS
|
||||
- **Backend:** API Gateway `https://api.microdao.xyz/v1`
|
||||
- **State:** React Query, Zustand/Context
|
||||
- **LLM:** OpenAI (через backend)
|
||||
|
||||
---
|
||||
|
||||
## 📖 Корисні посилання
|
||||
|
||||
- [Документація для Cursor](docs/cursor/README.md)
|
||||
- [Швидкий старт](QUICK_START.md)
|
||||
- [Контекст проєкту](PROJECT_CONTEXT.md)
|
||||
- [Налаштування Git](GIT_SETUP.md)
|
||||
|
||||
---
|
||||
|
||||
**Версія:** MVP v1.0
|
||||
**Останнє оновлення:** 2024-11-13
|
||||
|
||||
|
||||
Reference in New Issue
Block a user