solver-sdk 2.8.0 → 3.1.0

package/docs/README.md

@@ -1,37 +1,53 @@
-# 📚 Документация Solver SDK v2.7.0
-
-## 🎯 Быстрая навигация
-
-### Для VS Code Extension разработчиков:
-1. **[🚀 QUICK_START.md](QUICK_START.md)** - 5-минутный старт (начните отсюда!)
-2. **[📚 VSCODE_INTEGRATION.md](VSCODE_INTEGRATION.md)** - детальные примеры
-
-### Для backend разработчиков:
-1. **[🏗️ ARCHITECTURE.md](ARCHITECTURE.md)** - HTTP vs WebSocket архитектура
-2. **[🔌 WEBSOCKET.md](WEBSOCKET.md)** - WebSocket API и события
-3. **[🔑 AUTHENTICATION.md](AUTHENTICATION.md)** - настройка авторизации
-
-### Дополнительно:
-- **[❌ ERROR_HANDLING.md](ERROR_HANDLING.md)** - обработка ошибок
-- **[📁 features/](features/)** - документация по отдельным функциям
-- **[📦 indexing/](indexing/)** - работа с индексацией
-
-## 🚀 Примеры кода
-
-- **[../examples/vscode-integration-example.js](../examples/vscode-integration-example.js)** - полный пример VS Code интеграции
-
-## 💡 Рекомендуемый порядок изучения
-
-### Для новичков:
-1. Прочитайте [QUICK_START.md](QUICK_START.md) (5 минут)
-2. Запустите [пример](../examples/vscode-integration-example.js)
-3. При необходимости изучите [VSCODE_INTEGRATION.md](VSCODE_INTEGRATION.md)
-
-### Для опытных разработчиков:
-1. [ARCHITECTURE.md](ARCHITECTURE.md) - понимание архитектуры
-2. [WEBSOCKET.md](WEBSOCKET.md) - для WebSocket интеграции
-3. [ERROR_HANDLING.md](ERROR_HANDLING.md) - для production готовности
-
----
-
-**❓ Не нашли ответ? Загляните в [основной README](../README.md)** 
+# Code Solver SDK - Документация
+
+> **JavaScript/TypeScript SDK для VS Code Extensions**  
+> Подключение к AI бэкенду для индексации, поиска и работы с кодом
+
+## 📚 Основная документация
+
+### [📊 Индексация проектов](indexing/INDEXING.md)
+**Подробное руководство по индексации:**
+- Создание и поиск проектов
+- Запуск и мониторинг индексации
+- Workflow с обработкой ошибок
+- Практические примеры
+
+### [🔧 Интеграция с VS Code](VSCODE_INTEGRATION.md)
+**Готовые примеры для Extensions:**
+- Базовая настройка SDK
+- Индексация с прогресс-баром
+- Поиск функций с навигацией
+- AI Chat интеграция
+- Конфигурация package.json
+
+### [🚨 Обработка ошибок](ERROR_HANDLING.md)
+**Как правильно обрабатывать ошибки:**
+- Сетевые ошибки
+- Ошибки индексации
+- Retry логика
+- Graceful degradation
+
+## 🚀 Быстрый старт
+
+```javascript
+import { CodeSolverSDK } from 'solver-sdk';
+
+// 1. Инициализация
+const sdk = await CodeSolverSDK.create({
+  baseURL: 'http://localhost:3000'
+});
+
+// 2. Создание проекта
+const project = await sdk.projects.findOrCreateProject('/path/to/project', 'My Project');
+
+// 3. Индексация
+await sdk.projects.startIndexing(project.id);
+
+// 4. Поиск функций
+const results = await sdk.search.searchFunctions(project.id, {
+  query: 'user authentication',
+  limit: 10
+});
+```
+
+SDK готов к продакшену! ��