docs: split handbook into docs/ by topic, slim root README, add docs index

Made-with: Cursor
2026-04-21 15:37:43 +10:00
parent 25de357982
commit c589a216be
16 changed files with 713 additions and 524 deletions
@@ -0,0 +1,100 @@
+# Документация: навигация от простого к сложному
+
+Этот каталог — основной вход: кратко **о чём репозиторий**, затем **термины**, далее **установка OpenClaude**, **локальные модели**, **RAG/MCP**, **эксплуатация**, **Git**, **железо и продвинутые темы**.
+
+---
+
+## 0. Что это за проект и где брать CLI
+
+| Документ | О чём |
+|----------|--------|
+| [repository-and-cli.md](repository-and-cli.md) | Чем этот handbook отличается от OpenClaude CLI; как клонировать репозиторий; откуда ставится `@gitlawb/openclaude` |
+
+---
+
+## 1. Термины и контекст
+
+| Документ | О чём |
+|----------|--------|
+| [concepts-and-terms.md](concepts-and-terms.md) | LLM, токены, MCP, типовые провайдеры |
+
+---
+
+## 2. Установка и конфигурация OpenClaude
+
+| Документ | О чём |
+|----------|--------|
+| [install-openclaude-cli.md](install-openclaude-cli.md) | Node/npm, установка CLI, Ollama по ОС, переменные окружения и профили (локально / OpenAI / DeepSeek), PowerShell |
+| [configure-profiles-direnv.md](configure-profiles-direnv.md) | Файлы профилей в `~/.config/openclaude/profiles`, direnv, Windows vs WSL |
+
+---
+
+## 3. Локальные LLM (Ollama)
+
+| Документ | О чём |
+|----------|--------|
+| [local-llm-ollama.md](local-llm-ollama.md) | Каталог моделей, рекомендации «с чего начать», миф про «самообучение», обслуживание (`pull`/`rm`/место) |
+| [model-catalog.md](model-catalog.md) | Расширенный обзор семейств моделей |
+
+---
+
+## 4. RAG, MCP, стек из этого репозитория
+
+| Документ | О чём |
+|----------|--------|
+| [rag-mcp-stack.md](rag-mcp-stack.md) | Что такое RAG, из чего состоит стек, минимальная связка с Qdrant + MCP, чек-лист если MCP не виден |
+| [rag-mcp-starter/](rag-mcp-starter/) | Docker Compose, `index.py`, `mcp_server.py`, скрипты установки и обслуживания |
+
+---
+
+## 5. Быстрый старт по времени и ролям
+
+| Документ | О чём |
+|----------|--------|
+| [START-HERE.md](START-HERE.md) | План на 1 / 3 / 7 дней |
+| [quickstart-30min.md](quickstart-30min.md) | Пошагово «с нуля» на Ubuntu (~30 минут) |
+| [expectations.md](expectations.md) | Облако vs локально: честные ожидания |
+| [runtime-choice.md](runtime-choice.md) | Выбор рантайма и окружения |
+
+---
+
+## 6. Эксплуатация и автоматизация
+
+| Документ | О чём |
+|----------|--------|
+| [cron-examples.md](cron-examples.md) | Примеры cron для моделей и стека |
+| `../scripts/install-cron.sh` | Установка типовых cron-задач из репозитория |
+
+---
+
+## 7. Git, GitHub, репозитории кода
+
+| Документ | О чём |
+|----------|--------|
+| [github-auth-remotes.md](github-auth-remotes.md) | `gh auth`, PAT, HTTPS, SSH |
+| [github-ssh-setup-and-troubleshooting.md](github-ssh-setup-and-troubleshooting.md) | SSH к GitHub подробно и типовые ошибки |
+| [openclaude-with-repositories.md](openclaude-with-repositories.md) | Поток с кодом, MCP вокруг Git-платформ, проблемы `gh` в CI/облаке |
+
+---
+
+## 8. Железо, бенчмарки, дополнительные сценарии
+
+| Документ | О чём |
+|----------|--------|
+| [hardware-budgets.md](hardware-budgets.md) | Три бюджета железа под локальные LLM |
+| [bench-template.md](bench-template.md) | Шаблон benchmark своих задач |
+| [cursor-like-stack.md](cursor-like-stack.md) | Локальный стек в духе IDE |
+| [image-generation-local.md](image-generation-local.md) | Локальная генерация изображений |
+| [linux-server-fixes.md](linux-server-fixes.md) | BOM в shell-скриптах, зеркала apt |
+
+---
+
+## 9. Куда двигаться после базы
+
+| Документ | О чём |
+|----------|--------|
+| [roadmap-next-steps.md](roadmap-next-steps.md) | Следующие шаги после минимального контура |
+
+---
+
+Вся структура предполагает линейное чтение сверху вниз; для «только поднять стенд за вечер» достаточно цепочки **repository-and-cli** → **install-openclaude-cli** → **quickstart-30min** → **rag-mcp-starter**.