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

130
QUICK_START.md Normal file
View File

@@ -0,0 +1,130 @@
# 🚀 Швидкий старт MicroDAO MVP
## 📍 Де знаходиться проєкт
**Повний шлях:**
```
/Users/apple/Desktop/MicroDAO/MicroDAO 3
```
**Швидкий доступ:**
- Відкрити в Finder: `⌘ + Shift + G` → вставити шлях вище
- Відкрити в Terminal: `cd "/Users/apple/Desktop/MicroDAO/MicroDAO 3"`
- Створити символічне посилання (див. нижче)
## 🔧 Перший запуск
### 1. Встановити залежності
```bash
cd "/Users/apple/Desktop/MicroDAO/MicroDAO 3"
npm install
```
### 2. Запустити dev server
```bash
npm run dev
```
Проєкт відкриється автоматично на `http://localhost:3000`
### 3. Відкрити онбординг
Перейдіть на: `http://localhost:3000/onboarding`
## 📂 Створення швидкого доступу
### Варіант 1: Символічне посилання на робочому столі
```bash
ln -s "/Users/apple/Desktop/MicroDAO/MicroDAO 3" ~/Desktop/MicroDAO-Link
```
### Варіант 2: Додати в обрані (Finder)
1. Відкрити Finder
2. Перейти до `/Users/apple/Desktop/MicroDAO/MicroDAO 3`
3. Перетягнути папку в бічну панель (Sidebar)
### Варіант 3: Створити alias в Terminal
Додайте в `~/.zshrc` або `~/.bash_profile`:
```bash
alias microdao='cd "/Users/apple/Desktop/MicroDAO/MicroDAO 3"'
```
Потім:
```bash
source ~/.zshrc
microdao # Швидкий перехід до проєкту
```
## 🗂️ Про Continue / Pieces
**Continue** та **Pieces** — це IDE розширення, які:
- Зберігають контекст розмови локально
- Не зберігають сам проєкт (він на диску)
- Допомагають Cursor/VS Code згадувати попередні розмови
**Ваш проєкт зберігається:**
- Локально: `/Users/apple/Desktop/MicroDAO/MicroDAO 3`
- В Git: після підключення до GitHub/GitLab
## 📓 Jupyter Notebook
Jupyter Notebook підходить для:
- ✅ Документації та аналізу
- ✅ Python скриптів
-НЕ для React проєктів
**Можна створити:**
- `docs/analysis.ipynb` — для аналізу даних
- `docs/notes.ipynb` — для нотаток
## 🌐 Canvas Browser
**Я не можу безпосередньо запустити проєкт в Canvas browser**, але можу:
1. ✅ Запустити dev server локально
2. ✅ Відкрити браузер на `localhost:3000`
3. ✅ Показати скріншот через Canvas
**Щоб запустити:**
```bash
npm install
npm run dev
```
Потім відкрийте `http://localhost:3000` в браузері.
## 📝 Корисні команди
```bash
# Перейти до проєкту
cd "/Users/apple/Desktop/MicroDAO/MicroDAO 3"
# Встановити залежності
npm install
# Запустити dev server
npm run dev
# Збілдити для продакшн
npm run build
# Перевірити Git статус
git status
# Зробити коміт
git add .
git commit -m "Опис змін"
```
## 🔗 Корисні посилання
- Документація для Cursor: `docs/cursor/README.md`
- Налаштування Git: `GIT_SETUP.md`
- Структура проєкту: `src/README.md`