slaid098/opencode-config
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions
opencode-config/docs/handoff/pr-116-readme-standard-v2.md
Sergey 464fa6ec83
feat(readme): new bilingual standard v2 with features table (#116) 
* feat(readme): new bilingual standard v2 with features table

* docs(handoff): rename handoff and ADR to PR number convention

* docs(review): fix ADR-051 section name and add PR#116 refs

---------

Co-authored-by: opencode-agent <agent@opencode.local>
2026-07-29 03:22:28 +03:00

3.6 KiB
Raw Permalink Blame History

pr: 116 title: feat(readme): new bilingual standard v2 with features table

Что сделано

Обновлён create-readme tool (.opencode/tools/create-readme.ts):

  • Убраны параметры tier (flagship/utility), demo_gif, problem_en/ru, solution_en/ru — из типа CreateArgs, schema, execute().
  • Добавлены параметры why_en, what_en, why_ru, what_ru, features_en, features_ru (массив { emoji, name, description }[]).
  • Добавлена функция renderFeaturesTable() для рендеринга markdown-таблицы фич.
  • generateReadme() переписан под новый шаблон: Why/What вместо Problem/Solution, Features table между <!-- features-en/ru:start/end -->, custom_sections теперь вне delimiter tags (после features-en:end, до Quick Start).
  • validateReadme() обновлён: проверяет 4 пары разделителей (summary-en/ru + features-en/ru), непустой контент в каждой паре.
  • description тулзы обновлён (упоминание 4 пар разделителей).
  • .describe() для новых параметров; убраны для tier/demo_gif/problem/solution.

Обновлён скилл repo-readme (.opencode/skills/repo-readme/SKILL.md):

  • §2 (Tier system) убран полностью, секции перенумерованы (3→2, 4→3, …, 8→7).
  • §1 убрано упоминание tier.
  • §4 (Зачем разделители) — обновлён список: 4 пары (summary + features, EN + RU).
  • §5 (Шаблон README) — новый шаблон с Why/What + Features table.
  • §7 (Параметры тулзы) — обновлён список: убраны tier/demo_gif/problem/solution, добавлены why/what/features_en/features_ru.

README.md перегенерирован по новому стандарту (11 фич в Features table, EN + RU).

docs/project-map/README.md — описания repo-readme/SKILL.md и create-readme.ts обновлены (убрано "tier system", добавлено "features table, 4 delimiter pairs").

Проверки: tsc --noEmit (с --types node) чисто; pytest tests/test_permissions.py OK; check-permissions.py OK.

Почему

Problem/Solution не универсален для всех репо — не каждый проект укладывается в "проблема → решение". Tier system усложнял поддержку (два пути генерации). Features table — обязательная часть для витрины slaid098.dev: каждая карточка должна показывать фичи. 4 пары разделителей (summary + features, EN + RU) позволяют витрине парсить и summary, и таблицу фич независимо.

Pending

—

Watch out

custom_sections_en/ru теперь рендерятся ВНЕ delimiter tags — после <!-- features-en:end --> и до ### ⚡ Quick Start. В старом формате они были внутри <!-- summary-en:end -->. validate проверяет 4 пары разделителей вместо 2 — все существующие README, сгенерированные старой версией тулзы, не пройдут валидацию (нет features-en/ru delimiter pairs). Требуется перегенерация через create-readme (mode: create).