solver-sdk 2.6.3 → 2.7.1

package/docs/README.md

@@ -1,291 +1,37 @@
-# AI Solver SDK v2.5.0 Documentation
+# 📚 Документация Solver SDK v2.7.0
 
-Полная документация для AI Solver SDK версии 2.5.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)** - настройка авторизации
 
-```bash
-npm install @ai-solver/sdk
-```
+### Дополнительно:
+- **[❌ ERROR_HANDLING.md](ERROR_HANDLING.md)** - обработка ошибок
+- **[📁 features/](features/)** - документация по отдельным функциям
+- **[📦 indexing/](indexing/)** - работа с индексацией
 
-### Базовое использование
+## 🚀 Примеры кода
 
-```javascript
-import { CodeSolverSDK } from '@ai-solver/sdk';
+- **[../examples/vscode-integration-example.js](../examples/vscode-integration-example.js)** - полный пример VS Code интеграции
 
-const sdk = CodeSolverSDK.create({
-  baseURL: 'http://localhost:3000',
-  apiKey: 'dev_sk_test_12345678',
-  autoConnect: false
-});
+## 💡 Рекомендуемый порядок изучения
 
-// Создание проекта
-const project = await sdk.projects.create({
-  name: 'My AI Project',
-  path: '/path/to/project'
-});
+### Для новичков:
+1. Прочитайте [QUICK_START.md](QUICK_START.md) (5 минут)
+2. Запустите [пример](../examples/vscode-integration-example.js)
+3. При необходимости изучите [VSCODE_INTEGRATION.md](VSCODE_INTEGRATION.md)
 
-// AI Chat
-const response = await sdk.chat.send([
-  { role: 'user', content: 'Проанализируй этот код' }
-], {
-  projectId: project.id,
-  thinking: true
-});
-```
-
-## 📚 Документация
-
-### Основные руководства
-
-| Документ | Описание |
-|----------|----------|
-| **[API Reference](./API_REFERENCE.md)** | Полное описание всех методов SDK |
-| **[Integration Guide v2.5](./INTEGRATION_GUIDE_V2.5.md)** | Пошаговое руководство интеграции |
-| **[WebSocket API](./WEBSOCKET.md)** | WebSocket события и real-time функции |
-| **[Authentication](./AUTHENTICATION.md)** | Аутентификация и API ключи |
-| **[Error Handling](./ERROR_HANDLING.md)** | Обработка ошибок и диагностика |
-
-### Специализированные функции
-
-| Документ | Описание |
-|----------|----------|
-| **[Thinking Features](./features/THINKING.md)** | Claude 4 thinking и tool calling |
-| **[Indexing Guide](./indexing/INDEXING.md)** | Индексация проектов |
-
-## ✨ Новые возможности v2.5.0
-
-### 🔄 Контролируемые подключения
-
-```javascript
-const sdk = CodeSolverSDK.create({
-  autoConnect: false // Ключевая настройка
-});
-
-// Подключение только когда нужно
-await sdk.projects.connectWebSocket();
-await sdk.reasoning.connectWebSocket();
-```
-
-### 🧠 Claude 4 Thinking Support
-
-```javascript
-await sdk.chat.stream(messages, {
-  thinking: true,
-  tool_choice: { type: 'auto' }
-}, (eventType, data) => {
-  if (eventType === 'thinking_delta') {
-    console.log('Thinking:', data.thinking);
-  }
-});
-```
-
-### 📊 Расширенная диагностика
-
-```javascript
-// Проверка всех endpoints
-const apiStatus = await sdk.diagnoseAPI();
-
-// Статус WebSocket соединений
-const wsStatus = await sdk.diagnoseWebSocket();
-```
-
-### 🔧 Helper функции
-
-```javascript
-import { 
-  createStandardDevelopmentTools,
-  createComplexAssistantMessage,
-  extractThinkingBlocks
-} from '@ai-solver/sdk';
-```
-
-## 🎯 API Endpoints
-
-### Projects API
-- `POST /api/v1/projects` - Создание проекта
-- `GET /api/v1/projects` - Список проектов
-- `POST /api/v1/projects/:id/index` - Запуск индексации
-
-### Reasoning API
-- `POST /api/v1/reasoning` - Создание reasoning
-- `POST /api/v1/reasoning/start/:id` - Запуск reasoning
-- `GET /api/v1/reasoning/project/:id` - Reasoning проекта
-
-### Chat API
-- `POST /api/v1/chat` - Обычный чат
-- `POST /api/v1/chat/stream` - Потоковый чат
-
-### Search API
-- `GET /api/v1/search/project/:id` - Поиск в проекте
-
-## 🔌 WebSocket Namespaces
-
-| Namespace | URL | События |
-|-----------|-----|---------|
-| **Projects** | `/projects` | `indexing_progress`, `indexing_complete` |
-| **Reasoning** | `/reasoning` | `reasoning_started`, `reasoning_completed` |
-| **Chat** | `/chat` | `text_delta`, `thinking_delta`, `tool_use` |
-
-## 🔑 Аутентификация
-
-### Development
-
-```bash
-export AI_SOLVER_API_KEY=dev_sk_test_12345678
-```
-
-### Production
-
-```bash
-export AI_SOLVER_API_KEY=sk_prod_1234567890abcd
-```
-
-## 🚨 Миграция с предыдущих версий
-
-### Основные изменения
-
-1. **Новый способ создания SDK**
-   ```javascript
-   // Старый способ
-   const sdk = new CodeSolverSDK(options);
-   
-   // Новый способ (v2.5.0)
-   const sdk = CodeSolverSDK.create(options);
-   ```
-
-2. **Контролируемые WebSocket**
-   ```javascript
-   // Обязательно добавить
-   autoConnect: false
-   ```
-
-3. **Новые алиасы методов**
-   ```javascript
-   // Reasoning API
-   await sdk.reasoning.create(data);   // вместо createReasoning()
-   await sdk.reasoning.start(id);      // вместо startReasoning()
-   
-   // Projects API
-   await sdk.projects.create(data);    // вместо createProject()
-   await sdk.projects.getAll();        // вместо getAllProjects()
-   ```
-
-## 📝 Примеры использования
-
-### Полный workflow
-
-```javascript
-async function completeWorkflow() {
-  // Создание SDK
-  const sdk = CodeSolverSDK.create({
-    baseURL: 'http://localhost:3000',
-    apiKey: process.env.AI_SOLVER_API_KEY,
-    autoConnect: false
-  });
-  
-  // Диагностика
-  const status = await sdk.diagnoseAPI();
-  console.log('API status:', status);
-  
-  // Создание проекта
-  const project = await sdk.projects.create({
-    name: 'AI Analysis',
-    path: '/path/to/code'
-  });
-  
-  // Индексация с WebSocket
-  await sdk.projects.connectWebSocket();
-  sdk.projects.onIndexingComplete(() => {
-    console.log('Indexing done!');
-  });
-  await sdk.projects.startIndexing(project.id);
-  
-  // AI Reasoning
-  await sdk.reasoning.connectWebSocket();
-  const reasoning = await sdk.reasoning.create({
-    projectId: project.id,
-    query: 'Анализируй архитектуру'
-  });
-  await sdk.reasoning.start(reasoning.id);
-  
-  // Chat с thinking
-  await sdk.chat.connectWebSocket();
-  await sdk.chat.stream([
-    { role: 'user', content: 'Объясни результаты' }
-  ], {
-    projectId: project.id,
-    thinking: true
-  });
-}
-```
-
-## 🛠️ Разработка и отладка
-
-### Debug режим
-
-```javascript
-const sdk = CodeSolverSDK.create({
-  baseURL: 'http://localhost:3000',
-  apiKey: 'dev_sk_test_12345678',
-  autoConnect: false,
-  headers: {
-    'X-Debug': 'true'
-  }
-});
-```
-
-### Логирование
-
-```javascript
-// Включение детального логирования
-localStorage.setItem('ai-solver-debug', 'true');
-```
-
-## 📊 Производительность
-
-### Рекомендации
-
-1. **Используйте autoConnect: false** для контроля ресурсов
-2. **Подключайтесь только к нужным WebSocket** namespace
-3. **Отключайтесь после завершения** операций
-4. **Используйте диагностику** для мониторинга
-
-### Monitoring
-
-```javascript
-// Мониторинг ошибок
-window.addEventListener('unhandledrejection', (event) => {
-  console.error('Unhandled SDK error:', event.reason);
-});
-
-// Метрики производительности
-const start = performance.now();
-await sdk.projects.create(data);
-const duration = performance.now() - start;
-console.log(`Operation took ${duration}ms`);
-```
-
-## 🔗 Полезные ссылки
-
-- **[GitHub Repository](https://github.com/ai-solver/sdk)**
-- **[NPM Package](https://www.npmjs.com/package/@ai-solver/sdk)**
-- **[Release Notes](../CHANGELOG.md)**
-- **[Issues & Support](https://github.com/ai-solver/sdk/issues)**
-
-## 📋 Совместимость
-
-| Компонент | Версия |
-|-----------|--------|
-| **Node.js** | 16.x+ |
-| **TypeScript** | 4.5+ |
-| **Browser** | Chrome 90+, Firefox 88+, Safari 14+ |
-| **Backend** | AI Solver Backend v1.0.0 |
+### Для опытных разработчиков:
+1. [ARCHITECTURE.md](ARCHITECTURE.md) - понимание архитектуры
+2. [WEBSOCKET.md](WEBSOCKET.md) - для WebSocket интеграции
+3. [ERROR_HANDLING.md](ERROR_HANDLING.md) - для production готовности
 
 ---
 
-**AI Solver SDK v2.5.0 Documentation**  
-**Последнее обновление:** 28 июня 2025  
-**Статус:** Stable Release 
+**❓ Не нашли ответ? Загляните в [основной README](../README.md)**