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:
Apple
2025-11-15 04:08:35 -08:00
parent 5520665600
commit c552199eed
138 changed files with 39624 additions and 40 deletions

121
PROJECT_INFO.md Normal file
View File

@@ -0,0 +1,121 @@
# 📍 Інформація про проєкт MicroDAO
## 🗂️ Де зберігається проєкт
### Локальне зберігання
```
/Users/apple/Desktop/MicroDAO/MicroDAO 3
```
### Швидкий доступ
- **Символічне посилання:** `~/Desktop/MicroDAO-QuickAccess`
- **В Finder:** `⌘ + Shift + G` → вставити шлях вище
- **В Terminal:** `cd "/Users/apple/Desktop/MicroDAO/MicroDAO 3"`
## 💾 Continue / Pieces — що це?
**Continue** та **Pieces** — це розширення для IDE (Cursor/VS Code), які:
### Що вони роблять:
- ✅ Зберігають **історію розмов** з AI локально
- ✅ Запам'ятовують **контекст проєкту** для кращої роботи Cursor
- ✅ Дозволяють **швидко знаходити** попередні розмови
### Що вони НЕ роблять:
-НЕ зберігають сам проєкт (він на вашому диску)
-НЕ є хмарним сховищем
-НЕ синхронізують код між пристроями
### Де знаходиться історія Continue/Pieces:
- **Continue:** `~/.continue/` (прихована папка)
- **Pieces:** залежить від налаштувань, зазвичай в `~/Library/Application Support/`
**Ваш проєкт завжди на:** `/Users/apple/Desktop/MicroDAO/MicroDAO 3`
## 📓 Jupyter Notebook
### Чи можна зберігати проєкт в Jupyter?
**Jupyter Notebook** підходить для:
- ✅ Документації та аналізу даних
- ✅ Python скриптів та експериментів
- ✅ Візуалізацій та нотаток
-**НЕ** для React/TypeScript проєктів
### Якщо хочете використати Jupyter:
Можна створити окремі ноутбуки для:
- `docs/analysis.ipynb` — аналіз даних проєкту
- `docs/notes.ipynb` — нотатки та ідеї
- `docs/api_examples.ipynb` — приклади використання API
**Але основний код React залишається в `src/`**
## 🌐 Canvas Browser
### Чи можу я запустити проєкт в Canvas?
**Canvas Browser** — це інструмент для перегляду веб-сторінок, але:
1. **Я не можу безпосередньо запустити** React проєкт в Canvas
2. **Але можу допомогти:**
- Налаштувати проєкт для запуску
- Запустити dev server локально
- Відкрити браузер на `localhost:3000`
- Показати скріншот через Canvas
### Як запустити проєкт:
```bash
# 1. Встановити залежності (один раз)
cd "/Users/apple/Desktop/MicroDAO/MicroDAO 3"
npm install
# 2. Запустити dev server
npm run dev
# 3. Відкрити в браузері
# Автоматично відкриється http://localhost:3000
# Або відкрийте вручну: http://localhost:3000/onboarding
```
## 🔍 Швидкий пошук проєкту
### Варіант 1: Spotlight (macOS)
Натисніть `⌘ + Space` і введіть: `MicroDAO 3`
### Варіант 2: Terminal alias
Додайте в `~/.zshrc`:
```bash
alias microdao='cd "/Users/apple/Desktop/MicroDAO/MicroDAO 3"'
```
### Варіант 3: Символічне посилання
Вже створено: `~/Desktop/MicroDAO-QuickAccess`
## 📊 Структура проєкту
```
MicroDAO 3/
├── docs/cursor/ # Документація для Cursor
├── src/ # React код
│ ├── api/ # API клієнти
│ ├── components/ # React компоненти
│ ├── pages/ # Сторінки
│ └── types/ # TypeScript типи
├── package.json # Залежності
├── vite.config.ts # Vite конфігурація
└── QUICK_START.md # Інструкції запуску
```
## 🚀 Наступні кроки
1. **Встановити залежності:** `npm install`
2. **Запустити проєкт:** `npm run dev`
3. **Відкрити онбординг:** `http://localhost:3000/onboarding`
4. **Підключити Git:** див. `GIT_SETUP.md`
---
**Важливо:** Проєкт зберігається локально на вашому комп'ютері. Continue/Pieces лише допомагають Cursor згадувати контекст, але не зберігають сам код.