Skip to content

docs(readme): rewrite to minimal bilingual without memory setup#93

Merged
slaid098 merged 4 commits into
mainfrom
docs/readme/minimal-bilingual
Jul 26, 2026
Merged

docs(readme): rewrite to minimal bilingual without memory setup#93
slaid098 merged 4 commits into
mainfrom
docs/readme/minimal-bilingual

Conversation

@slaid098

Copy link
Copy Markdown
Owner

Что сделано

README переписан в минималистичном bilingual стиле (~55 строк, было 247). Russian primary (## Русский, заголовки ### Быстрый старт, ### Структура, ### Конфигурация) + English (## English, заголовки ### Quick start, ### Structure, ### Configuration). Memory setup секция убрана полностью (модуль переписывается). Детальные Configuration/Troubleshooting/Environment variables таблицы убраны (.env.example = источник правды). Добавлены handoff + ADR-041.

Почему

Предыдущая версия (PR #89) имела смешение языков внутри секций (русские секции с английскими заголовками ### Quick start, ### Configuration) и была перегружена Memory setup деталями (~100 строк). Пользователь указал на недопустимость смешения языков внутри секций. Memory модуль переписывается — setup детали пока неактуальны.

Closes #92

Closes #92

@slaid098

Copy link
Copy Markdown
Owner Author

Docs Review Summary

  • Project map: no structural changes (README edit + handoff + ADR — content-only, project-map untouched)
  • Handoff: valid (4 sections filled: Что сделано, Почему, Pending=—, Watch out — meaningful)
  • ADR: valid (ADR-041: Статус=Accepted, Контекст, Решение, Альтернативы — 3 alternatives with rationale)

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

Summary

README переписан в минималистичный bilingual (~67 строк, было 247), Memory setup убран полностью, handoff + ADR-041 добавлены. Однако русская секция содержит английские описания в таблице Structure — это нарушает ключевое требование PR (устранить смешение языков внутри секций).

Critical (must fix before merge)

  • README.md:24-29 [bilingual] В русской секции ## Русский### Структура 5 из 8 описаний в таблице на английском, не на русском. PR docs(readme): bilingual cleanup with minimalism and fix stale command #89 критиковался именно за смешение языков — текущий PR исправил заголовки, но не содержимое таблицы.
    Текущее:
    | `.opencode/agents/` | Subagent definitions |
    | `.opencode/skills/` | Skill definitions (14 skills) |
    | `.opencode/scripts/` | Python scripts (pipeline-status, spec-status) |
    | `src/` | Python RAG CLI |
    | `docs/` | Handoffs, ADRs, project map |
    | `docker-compose.yml` | Docker compose config |
    
    Fix: перевести описания на русский, например:
    | `.opencode/agents/` | Определения subagent'ов |
    | `.opencode/skills/` | Определения навыков (14 skills) |
    | `.opencode/scripts/` | Python-скрипты (pipeline-status, spec-status) |
    | `src/` | Python RAG CLI |
    | `docs/` | Handoffs, ADRs, project map |
    | `docker-compose.yml` | Конфиг Docker compose |
    
    (технические термины subagent, skills, handoffs, ADRs допустимо оставить — но описательная часть должна быть русской)

Warnings (should fix)

  • docs/decisions/041-pr-93-readme-minimal-bilingual.md:19 [style] Нет trailing newline в конце файла (\ No newline at end of file в diff). Fix: добавить пустую строку в конце.
  • docs/handoff/pr-93-readme-minimal-bilingual.md:20 [style] Нет trailing newline в конце файла. Fix: добавить пустую строку в конце.

Positives

  • Memory setup секция убрана полностью (How it works, Prerequisites, Initialize, setup-memory.sh steps, Verify, Troubleshooting, Environment variables — ничего не осталось)
  • Заголовки в русской секции переведены (### Быстрый старт, ### Структура, ### Конфигурация)
  • Quick start = 3 строки bash + 1 строка localhost, 1 раз на язык ✅
  • Configuration = 1 строка на язык ✅
  • License сохранён ✅
  • Handoff (Что сделано / Почему / Pending / Watch out) + ADR-041 (Статус / Контекст / Решение / Альтернативы) добавлены, Closes docs(readme): rewrite to minimal bilingual without memory setup section #92 присутствует

Verdict: REQUEST_CHANGES

@slaid098

Copy link
Copy Markdown
Owner Author

Code Review Summary

Re-review после fix 5c2476a. Оба finding из предыдущего review адресованы.

Что проверено

Fix #1 — переводы в русской секции ### Структура (README.md:18-29): описания переведены на русский, технические термины сохранены. Английская секция ### Structure (README.md:48-59) не тронута — осталась на английском. Смешения языков внутри секций больше нет.

Fix #2 — trailing newline: добавлен во все 3 файла (README.md, ADR-041, handoff). Проверено побайтово — все файлы заканчиваются на \n.

Остальное (с первого review — OK)

  • Bilingual: ## Русский (полностью русский, заголовки тоже) + ## English (полностью английский) — соответствие ADR-041.
  • Минимализм: 67 строк (было 247), Memory setup убран полностью, Configuration = 1 строка.
  • Handoff docs/handoff/pr-93-readme-minimal-bilingual.md присутствует, все секции заполнены (Что сделано / Почему / Pending / Watch out).
  • ADR-041 присутствует, секции Статус / Контекст / Решение / Альтернативы заполнены.

Замечание (info, не блокирующее)

  • pipeline-status вернул AMBIGUOUS по CI: «нет CI run на ветке docs/readme/minimal-bilingual». Для docs-only PR это ожидаемо (CI триггеры обычно на code-файлы) — не блокирует review.

Verdict: APPROVE

@slaid098
slaid098 merged commit e6c3784 into main Jul 26, 2026
2 checks passed
@slaid098
slaid098 deleted the docs/readme/minimal-bilingual branch July 26, 2026 20:41
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): rewrite to minimal bilingual without memory setup section

1 participant