docs: перевод документации на канон av-dev

- Раскладка docs/ приведена к канону 2: заведены passport/architecture/
  database/security/review и research; docs/specs, drafts, backlog, review/
  и BRIEF.md разобраны и удалены, беклог переехал в docs/tasks (34 задачи,
  6 целей, слаги на английский).
- Нарративы specs удалены как дубли openspec-спек после поимённой сверки;
  остаток заведён задачами (редактор маппинга ревью, крайние случаи
  именования), отказ от сущности title промоутнут в ADR.
- Проектные копии агентов и скиллов ревью/пайплайна удалены в пользу
  плагинов av-dev-pm и av-dev-pipeline; в task gate добавлен шаг canon
  вместо er-schema.
This commit is contained in:
av
2026-08-04 09:27:26 +03:00
parent 08bef2cac0
commit 42d5b73a04
128 changed files with 1606 additions and 4889 deletions
+24 -18
View File
@@ -1,12 +1,13 @@
# Jellybit
Jellybit — связующий сервис между qBittorrent и Jellyfin. Принимает
magnet-ссылку вместе с текстовым контекстом, ставит загрузку в
magnet-ссылку или `.torrent`-файл вместе с текстовым контекстом, ставит загрузку в
qBittorrent, дожидается её завершения, распознаёт содержимое (фильм или
сериал, сезоны и серии) и раскладывает готовые файлы по конвенциям
библиотеки Jellyfin.
Полный замысел и причины — в [BRIEF.md](BRIEF.md).
Полный замысел, границы домена и типовые сценарии — в
[docs/passport.md](docs/passport.md).
## Зачем
@@ -40,8 +41,8 @@ TMDB/TVDB/TVMaze) → раскладка в библиотеку хардлин
уверенном результате либо через подтверждение человеком. Транспорты приёма:
REST API, веб-UI, Telegram-бот и CLI (`jellybit add`).
Из источников пока поддержан magnet; `.torrent` и обычные ссылки — в планах.
См. [дорожную карту](docs/drafts/roadmap.md).
Из источников поддержаны magnet и `.torrent`-файл; фетч `.torrent` по обычной
ссылке — в планах. Что дальше — [docs/tasks/PLAN.md](docs/tasks/PLAN.md).
## Документация
@@ -49,26 +50,31 @@ REST API, веб-UI, Telegram-бот и CLI (`jellybit add`).
[OpenSpec](https://github.com/Fission-AI/OpenSpec): изменение сначала
описывается спекой, потом реализуется.
- [openspec/](openspec/) — OpenSpec: актуальные capability-спеки в
`openspec/specs/`, изменения (proposal → design → tasks → archive) в
`openspec/changes/`. Capabilities постепенно переносятся сюда из
`docs/specs/`.
- [docs/conventions/](docs/conventions/) — конвенции кода (*как* пишем):
логирование ([logging.md](docs/conventions/logging.md)), конфигурация
([config.md](docs/conventions/config.md)), ошибки
([errors.md](docs/conventions/errors.md)).
- [docs/specs/](docs/specs/) — спецификации устройства системы
(архитектурный обзор + ещё не перенесённые в OpenSpec темы). Начать с
[architecture.md](docs/specs/architecture.md).
- [docs/adr/](docs/adr/) — журнал архитектурных решений (почему так).
- [docs/drafts/](docs/drafts/) — черновики: планы, идеи, нерешённое.
- [openspec/specs/](openspec/specs/) — **что система делает**, нормативно:
capability-спеки. Изменения (proposal → design → tasks → archive) в
`openspec/changes/`.
- [docs/passport.md](docs/passport.md) — зачем и для кого, чем **не** является.
- [docs/architecture.md](docs/architecture.md) — как сложено: компоненты,
внешние границы, эксплуатация, единые точки, деплой.
- [docs/database.md](docs/database.md) — схема хранилища и настройки.
- [docs/security.md](docs/security.md) — периметр и модель угроз.
- [docs/conventions/](docs/conventions/README.md) — как пишем код:
[логи](docs/conventions/logging.md), [ошибки](docs/conventions/errors.md),
[конфиг](docs/conventions/config.md), [БД](docs/conventions/database.md),
[веб-UI](docs/conventions/web-ui.md).
- [docs/adr/](docs/adr/README.md) — журнал решений (почему так), неизменяемый.
- [docs/research/](docs/research/README.md) — наблюдения за чужими форматами.
- [docs/tasks/](docs/tasks/BACKLOG.md) — задачи и цели.
Раскладка документации задана каноном av-dev и проверяется шагом `canon` в
`task gate`.
## Стек
Go (один статический бинарь), SQLite (`modernc.org/sqlite` + `sqlx`,
миграции `goose`), HTTP — `chi` + `html/template` + htmx, конфигурация —
TOML, логи — структурированный JSON (`slog`). Подробнее — в
[architecture.md](docs/specs/architecture.md).
[docs/architecture.md](docs/architecture.md).
## Конфигурация