docs: overhaul docs IA and multilingual navigation

2026-02-18 16:53:26 +08:00 · 2026-02-18 16:53:26 +08:00 · 93e5383cb2
commit 93e5383cb2
parent 5e800c38f1
40 changed files with 2495 additions and 198 deletions
--- a/README.ru.md
+++ b/README.ru.md
@ -0,0 +1,161 @@
+<p align="center">
+  <img src="zeroclaw.png" alt="ZeroClaw" width="200" />
+</p>
+
+<h1 align="center">ZeroClaw 🦀（Русский）</h1>
+
+<p align="center">
+  <strong>Zero overhead. Zero compromise. 100% Rust. 100% Agnostic.</strong>
+</p>
+
+<p align="center">
+  🌐 Языки: <a href="README.md">English</a> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.ja.md">日本語</a> · <a href="README.ru.md">Русский</a>
+</p>
+
+<p align="center">
+  <a href="bootstrap.sh">Установка в 1 клик</a> |
+  <a href="docs/README.ru.md">Хаб документации</a> |
+  <a href="docs/SUMMARY.md">TOC docs</a> |
+  <a href="docs/commands-reference.md">Команды</a> |
+  <a href="docs/config-reference.md">Конфиг</a> |
+  <a href="docs/providers-reference.md">Providers</a> |
+  <a href="docs/channels-reference.md">Channels</a> |
+  <a href="docs/operations-runbook.md">Операции</a> |
+  <a href="docs/troubleshooting.md">Диагностика</a> |
+  <a href="CONTRIBUTING.md">Вклад</a>
+</p>
+
+<p align="center">
+  <strong>Быстрые маршруты:</strong>
+  <a href="docs/getting-started/README.md">Старт</a> ·
+  <a href="docs/reference/README.md">Справочники</a> ·
+  <a href="docs/operations/README.md">Операции</a> ·
+  <a href="docs/troubleshooting.md">Диагностика</a> ·
+  <a href="docs/security/README.md">Безопасность</a> ·
+  <a href="docs/hardware/README.md">Аппаратная часть</a> ·
+  <a href="docs/contributing/README.md">Вклад и CI</a>
+</p>
+
+> Этот файл — выверенный перевод `README.md` с акцентом на точность и читаемость (не дословный перевод).
+>
+> Технические идентификаторы (команды, ключи конфигурации, API-пути, имена Trait) сохранены на английском.
+>
+> Последняя синхронизация: **2026-02-18**.
+
+## О проекте
+
+ZeroClaw — это производительная и расширяемая инфраструктура автономного AI-агента:
+
+- Нативно на Rust, единый бинарник, переносимость между ARM / x86 / RISC-V
+- Архитектура на Trait (`Provider`, `Channel`, `Tool`, `Memory` и др.)
+- Безопасные значения по умолчанию: pairing, явные allowlist, sandbox и scope-ограничения
+
+## Почему выбирают ZeroClaw
+
+- **Лёгкий**: небольшой бинарник, низкое потребление памяти, быстрый старт
+- **Расширяемый**: 28+ built-in providers (с алиасами) + custom совместимые endpoint
+- **Удобный в эксплуатации**: `daemon`, `doctor`, `status`, `service`
+- **Интеграции**: много каналов + 70+ integrations
+
+## Воспроизводимые метрики (пример)
+
+Текущие примерные значения из README (macOS arm64, 2026-02-18):
+
+- Размер release-бинарника: `8.8M`
+- `zeroclaw --help`: ~`0.02s`, пик памяти ~`3.9MB`
+- `zeroclaw status`: ~`0.01s`, пик памяти ~`4.1MB`
+
+Проверяйте производительность в своей среде:
+
+```bash
+cargo build --release
+ls -lh target/release/zeroclaw
+
+/usr/bin/time -l target/release/zeroclaw --help
+/usr/bin/time -l target/release/zeroclaw status
+```
+
+## Установка в 1 клик
+
+```bash
+git clone https://github.com/zeroclaw-labs/zeroclaw.git
+cd zeroclaw
+./bootstrap.sh
+```
+
+Для полной инициализации окружения: `./bootstrap.sh --install-system-deps --install-rust` (для системных пакетов может потребоваться `sudo`).
+
+Подробности: [`docs/one-click-bootstrap.md`](docs/one-click-bootstrap.md).
+
+## Быстрый старт
+
+```bash
+git clone https://github.com/zeroclaw-labs/zeroclaw.git
+cd zeroclaw
+cargo build --release --locked
+cargo install --path . --force --locked
+
+zeroclaw onboard --api-key sk-... --provider openrouter
+zeroclaw onboard --interactive
+
+zeroclaw agent -m "Hello, ZeroClaw!"
+
+# default: 127.0.0.1:3000
+zeroclaw gateway
+
+zeroclaw daemon
+```
+
+## Важные security-дефолты
+
+- Gateway по умолчанию: `127.0.0.1:3000`
+- Pairing обязателен по умолчанию: `require_pairing = true`
+- Публичный bind запрещён по умолчанию: `allow_public_bind = false`
+- Семантика allowlist каналов:
+  - `[]` => deny-by-default
+  - `["*"]` => allow all (используйте осознанно)
+
+## Пример конфигурации
+
+```toml
+api_key = "sk-..."
+default_provider = "openrouter"
+default_model = "anthropic/claude-sonnet-4"
+default_temperature = 0.7
+
+[memory]
+backend = "sqlite"
+auto_save = true
+embedding_provider = "none"
+
+[gateway]
+host = "127.0.0.1"
+port = 3000
+require_pairing = true
+allow_public_bind = false
+```
+
+## Навигация по документации
+
+- Хаб документации (English): [`docs/README.md`](docs/README.md)
+- Единый TOC docs: [`docs/SUMMARY.md`](docs/SUMMARY.md)
+- Хаб документации (Русский): [`docs/README.ru.md`](docs/README.ru.md)
+- Справочник команд: [`docs/commands-reference.md`](docs/commands-reference.md)
+- Справочник конфигурации: [`docs/config-reference.md`](docs/config-reference.md)
+- Справочник providers: [`docs/providers-reference.md`](docs/providers-reference.md)
+- Справочник channels: [`docs/channels-reference.md`](docs/channels-reference.md)
+- Операционный runbook: [`docs/operations-runbook.md`](docs/operations-runbook.md)
+- Устранение неполадок: [`docs/troubleshooting.md`](docs/troubleshooting.md)
+- Инвентарь и классификация docs: [`docs/docs-inventory.md`](docs/docs-inventory.md)
+- Снимок triage проекта: [`docs/project-triage-snapshot-2026-02-18.md`](docs/project-triage-snapshot-2026-02-18.md)
+
+## Вклад и лицензия
+
+- Contribution guide: [`CONTRIBUTING.md`](CONTRIBUTING.md)
+- PR workflow: [`docs/pr-workflow.md`](docs/pr-workflow.md)
+- Reviewer playbook: [`docs/reviewer-playbook.md`](docs/reviewer-playbook.md)
+- License: MIT ([`LICENSE`](LICENSE), [`NOTICE`](NOTICE))
+
+---
+
+Для полной и исчерпывающей информации (архитектура, все команды, API, разработка) используйте основной английский документ: [`README.md`](README.md).