Skip to content

docs(readme): bilingual cleanup with minimalism and fix stale command#89

Merged
slaid098 merged 3 commits into
mainfrom
docs/readme/bilingual-minimalism-cleanup
Jul 26, 2026
Merged

docs(readme): bilingual cleanup with minimalism and fix stale command#89
slaid098 merged 3 commits into
mainfrom
docs/readme/bilingual-minimalism-cleanup

Conversation

@slaid098

Copy link
Copy Markdown
Owner

Что сделано

Переписал README.md в минималистичном bilingual стиле: Russian primary + English 1:1 полный перевод.

  • Структура: ## Russian + ## English секции, каждая с Quick start / Structure / Configuration / Memory setup (7 подсекций) / License
  • Минимализм: таблицы вместо prose, 1-2 строки на концепт, code blocks ≤ 3 строк
  • 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)
  • ADR-039 + handoff добавлены

Почему

Старый 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 для международной аудитории.

Closes #88

Closes #88

@slaid098

Copy link
Copy Markdown
Owner Author

Docs Review Summary

  • Project map: no structural changes (README edit + handoff + ADR — content only, no new dirs/modules)
  • Handoff: valid (4 sections filled: Что сделано / Почему / Pending / Watch out — all meaningful)
  • ADR: valid (039-pr-89-readme-bilingual-cleanup.md — Статус / Контекст / Решение / Альтернативы all filled)

Spec Cleanup

  • Spec: n/a (docs/spec/roadmap.md does not exist)

Verdict: NO_CHANGES

@slaid098

Copy link
Copy Markdown
Owner Author

Code Review Summary

Чистый docs-only PR: README переписан в bilingual структуре (RU primary + EN 1:1) с минимализмом. Fix C1 применён корректно, дублирование устранено, 7 подсекций Memory setup сохранены в обоих языках. Handoff + ADR-039 валидны, Closes #88.

Positives

  • Fix C1 корректен: docker exec opencode /root/.config/opencode/scripts/setup-memory.sh (L70, L190) — соответствует bind-mount ./.opencode:/root/.config/opencode в docker-compose.yml. Старый путь /root/workspace/opencode-config был неверным (working_dir = /root/workspace без subdir).
  • Bilingual 1:1: ## Russian (L5) + ## English (L125) с идентичной структурой — Quick start / Structure / Configuration / Memory setup (7 подсекций) / License. Перевод полный, не summary.
  • No duplication: env table 1 на группу (6 non-memory в Configuration + 10 memory в Environment variables), cp .env.example .env 1×/язык (L12, L132), git clone ... cd 1×/язык (L10-11, L130-131).
  • Memory setup 7 подсекций в обоих языках: How it works, Prerequisites, Initialize, setup-memory.sh steps, Verify, Troubleshooting (6 строк ≥5), Environment variables (10 vars).
  • Verify commands точны: wrapper path node_modules/@mathew-cf/rag-cli/bin/rag.js, meta format version + sha256, .rag/ listing index.json + meta.json + .lock (no index.bin), search args search "..." -i $OPENCODE_MEMORY_DIR/.rag -k 3 --json.
  • Accuracy: 10 env vars совпадают с .env.example (OPENCODE_MEMORY_DIR, OPENCODE_MEMORY_REMOTE, OPENAI_BASE_URL, OPENAI_API_KEY, OPENAI_EMBEDDING_MODEL, OPENAI_EMBEDDING_BATCH_SIZE, MEMORY_CHUNK_SIZE, MEMORY_CHUNK_OVERLAP, MEMORY_WRAPPER_PATH, MEMORY_WRAPPER_PYTHON). Defaults корректны (batch=50, chunk=512, overlap=64, model=qwen/qwen3-embedding-8b).
  • Minimalism: таблицы вместо prose, 1-2 строки на концепт, code blocks ≤ 3 строк (Verify разбит на 2 блока для читаемости — допустимо).
  • PR hygiene: title docs(readme): bilingual cleanup with minimalism and fix stale command (conventional), body с "Что сделано"/"Почему", Closes docs(readme): bilingual cleanup with minimalism and fix stale command #88, 3 коммита все docs. Handoff docs/handoff/pr-89-readme-bilingual-cleanup.md с всеми секциями (Что сделано, Почему, Pending, Watch out). ADR-039 с Статус/Контекст/Решение/Альтернативы.

Suggestions (info, not blocking)

  • README.md:43, 163 [accuracy] Anchor [Memory setup → Environment variables](#environment-variables-1) использует суффикс -1 (GitHub auto-suffix для второго вхождения заголовка). Автор уже отметил это в handoff Watch out — проверить работает ли ссылка после merge на GitHub render.
  • README.md:34-41, 154-161 [completeness] Configuration table содержит 6 non-memory vars, но .env.example также имеет TELEGRAM_API_ID/API_HASH/BOT_TOKEN и CLOUDFLARE_TUNNEL_TOKEN/TUNNEL_DOMAIN (optional). Они опущены — вероятно намеренно для минимализма (consistent с предыдущим README). Если хочется полноты, можно добавить строку "See .env.example for optional Telegram/Cloudflare vars".
  • docs/handoff/pr-89-readme-bilingual-cleanup.md:11 [nit] Handoff заявляет "246 строк", фактический README — 247 строк. Тривиальное расхождение.

Verdict: APPROVE

@slaid098
slaid098 merged commit eb5697e into main Jul 26, 2026
2 checks passed
@slaid098
slaid098 deleted the docs/readme/bilingual-minimalism-cleanup branch July 26, 2026 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): bilingual cleanup with minimalism and fix stale command

1 participant