Skip to content

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

Description

@slaid098

Контекст

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

Задача

Кардинальная переработка README в минималистичном bilingual стиле:

  1. Bilingual: ## Русский (полностью русский, заголовки тоже) + ## English (полностью английский). Никакого смешения языков внутри секций.
  2. Минимализм: ~50-60 строк (было 247), таблицы вместо prose, 1-2 строки на концепт
  3. Убрать Memory setup полностью (все 7 подсекций) — модуль переписывается
  4. Убрать детальные Configuration/Troubleshooting/Environment variables таблицы — .env.example источник правды
  5. Оставить: title + 1 строка описания, Quick start (3 строки bash), Structure (7-8 строк таблица), Configuration (1 строка), License

Структура

# opencode-config
[1 строка: что это]

## Русский
### Быстрый старт
[3 строки bash: clone, cp .env, docker compose up -d]
[1 строка: localhost:4096]

### Структура
[таблица 7-8 строк: AGENTS.md, .opencode/, .opencode/agents/, .opencode/skills/, .opencode/scripts/, src/, docs/, docker-compose.yml]

### Конфигурация
[1 строка: "Скопируйте .env.example → .env, заполните ключи."]

## English
### Quick start
[те же 3 строки bash + 1 строка]

### Structure
[та же таблица 7-8 строк на английском]

### Configuration
[1 строка: "Copy .env.example → .env, fill in keys."]

## License
MIT — see [LICENSE](LICENSE).

Критерии приемки

  • README содержит ## Русский (полностью русский, заголовки ### Быстрый старт, ### Структура, ### Конфигурация) и ## English (полностью английский, заголовки ### Quick start, ### Structure, ### Configuration)
  • Нет Memory setup секции (How it works, Prerequisites, Initialize, setup-memory.sh steps, Verify, Troubleshooting, Environment variables — всё убрано)
  • Нет детальных Configuration/Troubleshooting/Environment variables таблиц
  • Quick start: 3 строки bash (clone, cp .env, docker compose up -d) + 1 строка про localhost:4096, 1 раз на язык
  • Structure таблица 7-8 строк (с .opencode/agents/, .opencode/skills/, .opencode/scripts/ подсекциями)
  • Configuration = 1 строка на язык (.env.example.env, заполнить ключи)
  • Объём ~50-60 строк (было 247)
  • Никакого смешения языков внутри секций (русские секции полностью русские, английские полностью английские)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions