4e926a43a7
* fix(readme): russian heading, simplified support, access_url, env username * fix(ci): wrap long assert to satisfy ruff E501 in test_permissions.py * docs(project-map): add PR#118 tags (create-readme, repo-readme, .env.example) * fix(ci): format test_permissions.py for ruff format check --------- Co-authored-by: opencode-agent <agent@opencode.local>
48 lines
No EOL
3.1 KiB
Markdown
48 lines
No EOL
3.1 KiB
Markdown
# ADR-052: README fixes — Russian heading, simplified support, access_url
|
||
|
||
## Статус
|
||
Accepted (2026-07-29)
|
||
|
||
## Контекст
|
||
|
||
Стандарт v2 (ADR-051, PR#116) оставил несколько шероховатостей:
|
||
|
||
- RU заголовок `## 🇷🇺 Русская версия` — длиннее нужного, anchor
|
||
`#-русская-версия` многословен. "Русский" короче и естественнее.
|
||
- Support блок содержал строку `Have questions or want to support?` —
|
||
избыточно, ссылка `slaid098.dev/support` самодостаточна.
|
||
- Не было параметра для указания URL web-доступа после Quick Start. Репо с
|
||
web-интерфейсом (opencode-config — http://localhost:4096) не показывали
|
||
пользователю куда идти.
|
||
- `OPENCODE_SERVER_USERNAME` отсутствовал в `.env.example` — opencode server
|
||
требует username, но шаблон не упоминал его.
|
||
|
||
## Решение
|
||
|
||
4 фикса + усиление validate:
|
||
|
||
- **RU заголовок:** `## 🇷🇺 Русская версия` → `## 🇷🇺 Русский`. Switcher
|
||
anchor: `[Русский](#-русская-версия)` → `[Русский](#-русский)`.
|
||
- **Support блок:** убрана строка `Have questions or want to support?`,
|
||
оставлена только ссылка `👉 **[slaid098.dev/support]...`.
|
||
- **`access_url`** — новый optional параметр тулзы `create-readme`. Если
|
||
передан, после Quick Start bash-блока добавляется `Access at {url}` (EN) и
|
||
`Доступ: {url}` (RU). Если не передан — ничего не добавляется (обратно
|
||
совместимо).
|
||
- **`OPENCODE_SERVER_USERNAME`** добавлен в `.env.example` (перед
|
||
`OPENCODE_SERVER_PASSWORD`).
|
||
- **`validate`** — 2 новые проверки: заголовок `## 🇷🇺 Русский` и anchor
|
||
`[Русский](#-русский)`. Существующие README со старым "Русская версия" не
|
||
пройдут валидацию — требуют перегенерации.
|
||
|
||
## Альтернативы
|
||
|
||
- **Сохранить "Русская версия"** — отвергнуто: длиннее, anchor
|
||
`#-русская-версия` многословен. "Русский" короче и естественнее для
|
||
носителя языка.
|
||
- **Оставить "Have questions or want to support?" в Support** — отвергнуто:
|
||
избыточно. Ссылка `slaid098.dev/support` самодостаточна, описание
|
||
перегружает блок.
|
||
- **`access_url` как обязательный параметр** — отвергнуто: не все репо имеют
|
||
web-доступ (CLI-утилиты, библиотеки). Optional — обратно совместимо, репо
|
||
без web-доступа просто не передают параметр. |