eb5697e28f
* docs(readme): rewrite with bilingual structure and minimalism * docs(handoff): add handoff + ADR for README cleanup * docs(handoff): set PR number --------- Co-authored-by: opencode-agent <agent@opencode.local>
28 lines
No EOL
3.1 KiB
Markdown
28 lines
No EOL
3.1 KiB
Markdown
---
|
||
pr: 89
|
||
title: docs(readme): bilingual cleanup with minimalism and fix stale command
|
||
---
|
||
|
||
## Что сделано
|
||
|
||
Переписал README.md в минималистичном bilingual стиле: Russian primary + English 1:1 полный перевод.
|
||
- Структура: `## Russian` + `## English` секции, каждая с Quick start / Structure / Configuration / Memory setup (7 подсекций) / License
|
||
- Минимализм: таблицы вместо prose, 1-2 строки на концепт, code blocks ≤ 3 строк (verify команды разбиты на 2 блока для читаемости)
|
||
- **Fix C1**: docker exec команда исправлена на реальный путь в контейнере `/root/.config/opencode/scripts/setup-memory.sh` (bind-mount `./.opencode:/root/.config/opencode`), вместо старого `/root/workspace/opencode-config && .opencode/scripts/setup-memory.sh`
|
||
- Убрано дублирование: env table 1 на группу (не 2), `cp .env.example .env` 1 раз на язык, `git clone ... cd opencode-config` 1 раз на язык
|
||
- Memory setup 7 подсекций preserved и сжаты: How it works, Prerequisites, Initialize, setup-memory.sh steps, Verify, Troubleshooting (6 строк), Environment variables (10 vars)
|
||
- Объём: 246 строк (RU + EN + License), English = точный 1:1 перевод Russian
|
||
|
||
## Почему
|
||
|
||
Старый README (176 строк, English-only) содержал дублирование: env vars в 2 таблицах, `cp .env.example .env` 4 раза, `git clone ... cd` 3 раза. Команда `docker exec` в Initialize секции указывала на несуществующий путь (`/root/workspace/opencode-config` — compose working_dir `/root/workspace` без opencode-config subdir). Bilingual структура улучшает доступность для русскоязычных пользователей (основная аудитория) и сохраняет English для международной аудитории.
|
||
|
||
## Pending
|
||
|
||
— после merge: удалить старый handoff `docs/handoff/pr-86-readme-memory-setup-instructions.md` (заменён этим PR) — если принято отдельным PR
|
||
|
||
## Watch out
|
||
|
||
- Объём 246 строк вместо заявленных ~160: 7 Memory setup подсекций × 2 языка + troubleshooting 6 строк + 10 env vars требуют места; приоритет — содержательные требования issue (#88) над оценкой
|
||
- Anchor `[Memory setup → Environment variables](#environment-variables-1)` — GitHub добавляет `-1` суффикс для второго вхождения заголовка (RU → EN). Проверить работает ли ссылка после merge
|
||
- Verify команды разбиты на 2 code blocks (cat/ls + node search) — issue требовало "code blocks ≤ 3 строк", но это не строгое нарушение (логическая группировка) |