Skip to content

Commit b817508

Browse files
Актуализировать документацию
1 parent ae204f4 commit b817508

6 files changed

Lines changed: 49 additions & 8 deletions

File tree

‎AGENTS.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,18 @@
9898
Результаты / ограничения записывайте в docs/validation.md, историю — в CHANGELOG.
9999
- Перед разрешённым commit: все клиентские тесты, проверка VERSION и неизменности
100100
key / ID, git diff --check и staged diff. Push без force в запрошенную ветку.
101+
102+
## Согласованность документации
103+
104+
- Карта актуальных инструкций — [docs/README.md](docs/README.md). README описывает
105+
текущий запуск, профильные инструкции — детали, CHANGELOG — изменения, validation —
106+
датированные результаты. Исторический результат не подтверждает текущий прогон.
107+
- Сверяйте команды с Dockerfile, Compose, package scripts / pytest и CI. Основной
108+
путь тестирования — контейнер; команды на хосте допустимы как отдельная разработка.
109+
- При изменении контракта обновляйте его описание и mock в соответствующем проекте.
110+
Межрепозиторные ссылки ведут на GitHub; расположение checkout не является контрактом.
111+
- Wiki, playground, старые релизы и датированные отчёты не заменяют действующие
112+
инструкции. Не переносите оттуда старую авторизацию, версии или deployment-команды.
113+
- При потере файлов сначала проверьте историю, reflog и недостижимые объекты Git.
114+
Не выполняйте reset, clean или gc; восстановление файла не означает восстановление
115+
всех незакоммиченных изменений. Секреты и рабочие данные не выводите.

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66

77
## [Unreleased]
88

9+
- Согласованы инструкции запуска, тестирования и версий; добавлена карта документации,
10+
исторические отчёты отделены от актуальных команд.
11+
912
### Работа расширения
1013

1114
- При открытии popup показывается результат проверки обновлений и HTTPS-ссылка

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
с отправкой в основной прокторинг или ручной выгрузкой.
55
Текущая версия — в [VERSION](VERSION). Подготовка ведётся в `pre-release`.
66

7+
Карта инструкций и границы проверок: [docs/README.md](docs/README.md).
8+
79
## Связанные проекты и область поддержки
810

911
- [proctoring](https://github.com/OSLL/proctoring) — пользовательский вход, приём видео,

‎docs/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Документация расширения
2+
3+
- [README](../README.md) — настройка сервера, обновление и запуск тестов.
4+
- [Инструкция пользователю](../client/README.md) — установка, запись и восстановление.
5+
- [API](../client/API-COMPATIBILITY.md) — контракт веб-прокторинга.
6+
- [AGENTS](../AGENTS.md) — правила разработки и сохранности записей.
7+
- [Тесты](../tests/README.md), [mock API](../tests/mocks/README.md),
8+
[матрица сценариев](test-coverage.md), [результаты проверок](validation.md).
9+
- [Версии](versioning.md), [изменения](../CHANGELOG.md),
10+
[план обновления](production-upgrade.md).
11+
12+
Рабочий продукт — `client`; отдельного сервера в репозитории нет. Node, Chrome,
13+
Xvfb и ffprobe для тестов устанавливаются в Docker, локально и в CI используется
14+
один Compose-сервис. Внешний backend заменён mock; его contract-тесты проверяют
15+
заглушку, а не развёрнутые web/ML. Настоящий сквозной runner находится в
16+
[web-репозитории](https://github.com/OSLL/proctoring/blob/pre-release/tests/extension/README.md).
17+
18+
Playground содержит исторические эксперименты. Датированные validation-отчёты
19+
сохраняют результаты и ограничения своего прогона. Проверка callback четырёхчасового
20+
лимита не подтверждает многочасовую запись. Версии проектов независимы.

‎docs/validation.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Проверки клиента
22

3+
## Согласование документации — 28.10.2026
4+
5+
- Инструкции сверены с текущими Docker/Compose, тестовыми entrypoints и CI.
6+
Добавлена [карта документов](README.md); исторические отчёты отделены от текущего запуска.
7+
- Проверены локальные Markdown-ссылки и whitespace diff. Код приложения, env,
8+
рабочие сервисы и данные не менялись; тесты приложений повторно не запускались.
9+
310
## Финализация перед коммитом — 28.10.2026
411

512
- Ссылки на основной прокторинг и ML заменены GitHub-ссылками. В рабочем коде,
@@ -38,7 +45,6 @@ Playwright 1.64.1; ESLint 9.39.1 и Prettier 3.6.2 закреплены lock-ф
3845
architecture-repeat.log и architecture-selected.log в том же игнорируемом каталоге.
3946
Инструкция с разбором существующего сценария: [tests/README.md](../tests/README.md).
4047

41-
4248
## Docker / Compose — 26.10.2026
4349

4450
- Docker 29.9.2, Compose 5.6.1: `docker compose build tests` и запуск
@@ -57,7 +63,6 @@ architecture-repeat.log и architecture-selected.log в том же игнори
5763
Отчёты: tests/reports/{results.json,junit.xml,html/}; логи контейнерных прогонов:
5864
`tests/reports/docker-run.log`, `tests/reports/docker-ci-run.log`.
5965

60-
6166
## Реорганизация тестов и mock API — 26.10.2026
6267

6368
- Чистая установка `npm --prefix tests ci --ignore-scripts` и `format:check` проходят.
@@ -91,7 +96,6 @@ Windows и многочасовая запись остаются отдельн
9196

9297
Инструкция для новых участников: [tests/README.md](../tests/README.md).
9398

94-
9599
## До реорганизации: unit, UI и CI — 26.10.2026
96100

97101
- `npm --prefix tests run test:unit`: 61/61 client и 5/5 version, без skips.
@@ -125,7 +129,6 @@ Unit / coverage: `/tmp/plugin-node24-unit.log`; Chrome stdout: `/tmp/plugin-node
125129
устойчивость. Callback четырёхчасового предела проверен без ожидания четырёх часов.
126130
Матрица проверок и оставшиеся границы: [test-coverage.md](test-coverage.md).
127131

128-
129132
## Упаковка GitHub Release — 26.10.2026
130133

131134
- Проверены реальные шаги последнего завершённого job: из 53 секунд 44 занимали
@@ -141,7 +144,6 @@ Unit / coverage: `/tmp/plugin-node24-unit.log`; Chrome stdout: `/tmp/plugin-node
141144
- Новая GitHub job / публикация не запускалась. Текущий удалённый job не отменялся;
142145
локальная правка не меняет уже запущенный workflow. Коммит / push не выполнялись.
143146

144-
145147
## Открытие popup — 25.10.2026
146148

147149
- Клиентские Node-тесты: 20/20; VERSION / manifest / ID: проверка пройдена.

‎docs/versioning.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77
этого номера: их файлы не читаются, не копируются и не перезаписываются.
88
Репозиторий можно использовать отдельно, без соседних checkout.
99

10-
Сейчас всем трём связанным проектам назначен одинаковый начальный номер, но далее
11-
версии могут повышаться независимо. Совместимость определяется API-контрактом и
12-
проверками, а не равенством версий. GitHub-теги не заменяют локальный VERSION.
10+
Версия каждого связанного проекта повышается независимо. Совместимость определяется
11+
API-контрактом и проверками, а не равенством версий. GitHub-теги не заменяют локальный VERSION.
1312

1413
## Изменение и проверка
1514

0 commit comments

Comments
 (0)