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:
151
HOW_TO_REFERENCE.md
Normal file
151
HOW_TO_REFERENCE.md
Normal file
@@ -0,0 +1,151 @@
|
||||
# 🔗 Як посилатись на проєкт microDAO2
|
||||
|
||||
**Швидкий гайд для посилань в чатах та Cursor**
|
||||
|
||||
---
|
||||
|
||||
## 📍 Швидке посилання (копіюй це)
|
||||
|
||||
### Для Cursor / AI чатів
|
||||
|
||||
```
|
||||
Проєкт: microDAO2
|
||||
Шлях: /Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
Документація: docs/cursor/ (31 документ)
|
||||
```
|
||||
|
||||
### Коротка версія
|
||||
|
||||
```
|
||||
microDAO2: /Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Що завжди вказувати
|
||||
|
||||
### 1. Повний шлях до проєкту
|
||||
```
|
||||
/Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
```
|
||||
|
||||
### 2. Де документація
|
||||
```
|
||||
docs/cursor/ - 17+ документів для Cursor
|
||||
```
|
||||
|
||||
### 3. Ключові файли
|
||||
```
|
||||
PROJECT_CONTEXT.md - швидкий контекст
|
||||
README.md - головний README
|
||||
docs/cursor/README.md - навігація по документації
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💬 Приклади використання в чатах
|
||||
|
||||
### Приклад 1: Швидке посилання
|
||||
```
|
||||
Працюю над проєктом microDAO2:
|
||||
/Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
|
||||
Документація: docs/cursor/ (31 документ)
|
||||
```
|
||||
|
||||
### Приклад 2: З контекстом
|
||||
```
|
||||
Проєкт: microDAO2
|
||||
Локація: /Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
Документація: docs/cursor/ (31 документ)
|
||||
Статус: Документація готова, починаємо реалізацію MVP
|
||||
```
|
||||
|
||||
### Приклад 3: Для Cursor
|
||||
```
|
||||
Додай в контекст:
|
||||
/Users/apple/Desktop/MicroDAO/MicroDAO 3/docs/cursor/
|
||||
|
||||
Або конкретний файл:
|
||||
/Users/apple/Desktop/MicroDAO/MicroDAO 3/docs/cursor/21_agent_only_interface.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📂 Структура для швидкого доступу
|
||||
|
||||
### Ключові папки
|
||||
```
|
||||
/Users/apple/Desktop/MicroDAO/MicroDAO 3/
|
||||
├── docs/cursor/ # ← Документація для Cursor
|
||||
├── src/ # ← Код проєкту
|
||||
└── PROJECT_CONTEXT.md # ← Швидкий контекст
|
||||
```
|
||||
|
||||
### Ключові файли
|
||||
- `PROJECT_CONTEXT.md` - швидкий доступ до всього
|
||||
- `README.md` - головний README
|
||||
- `docs/cursor/README.md` - навігація по документації
|
||||
- `22_agent_only_interface_tasks.md` - поточні задачі
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Рекомендований порядок роботи
|
||||
|
||||
### Варіант 1: Спочатку документація (рекомендовано)
|
||||
1. ✅ Завершити всі документи (14-20 з плану)
|
||||
2. ⏳ Потім почати реалізацію
|
||||
3. ✅ Переваги: повне розуміння, менше переробок
|
||||
|
||||
### Варіант 2: Паралельно
|
||||
1. ✅ Базові документи (01-13) - готові
|
||||
2. ⏳ Реалізувати базові компоненти
|
||||
3. ⏳ Паралельно додавати документи 14-20
|
||||
4. ✅ Переваги: швидший старт, ітеративний підхід
|
||||
|
||||
**Рекомендація:** Варіант 1 - спочатку завершити документацію, потім реалізація.
|
||||
|
||||
---
|
||||
|
||||
## 📋 Чеклист для нового чату
|
||||
|
||||
Коли починаєш новий чат з Cursor або AI:
|
||||
|
||||
- [ ] Вказати повний шлях: `/Users/apple/Desktop/MicroDAO/MicroDAO 3`
|
||||
- [ ] Згадати про документацію: `docs/cursor/`
|
||||
- [ ] Вказати конкретну задачу або документ (якщо є)
|
||||
- [ ] Додати `PROJECT_CONTEXT.md` в контекст (якщо потрібно)
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Шаблони промптів
|
||||
|
||||
### Шаблон 1: Загальна задача
|
||||
```
|
||||
Проєкт: /Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
Документація: docs/cursor/
|
||||
|
||||
Задача: [опиши задачу]
|
||||
```
|
||||
|
||||
### Шаблон 2: Конкретний документ
|
||||
```
|
||||
Використовуй документацію:
|
||||
/Users/apple/Desktop/MicroDAO/MicroDAO 3/docs/cursor/21_agent_only_interface.md
|
||||
|
||||
Задача: [опиши задачу]
|
||||
```
|
||||
|
||||
### Шаблон 3: З контекстом
|
||||
```
|
||||
Проєкт: /Users/apple/Desktop/MicroDAO/MicroDAO 3
|
||||
Контекст: PROJECT_CONTEXT.md
|
||||
Документація: docs/cursor/
|
||||
|
||||
Задача: [опиши задачу]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Готово!** Тепер ти можеш легко посилатись на проєкт в будь-якому чаті.
|
||||
|
||||
Reference in New Issue
Block a user