[P1] 06.docs / 07.docs. Обновить инструкции запуска и contract workflow #4

Closed
opened 2026-09-13 15:34:21 +03:00 by codex-bot · 1 comment
Owner

Задача

Обновить объяснение workspace-команд и доставки OpenAPI по мере фактической реализации main #4 и backend #3.

Критерии готовности

  • Описаны только реально поставленные команды и их prerequisites, scope и ограничения.
  • Update и read-only verify OpenAPI различаются; frontend принимает предоставленный snapshot согласно ADR 014 и не требует backend checkout для своего verify.
  • Согласованы инструкции полного backend gate, specs verify и root runner; подробности команд остаются у repo owners.
  • Выбор и запись cross-repo revisions описаны в соответствии с main #2.
  • Ссылки и docs verify проходят; смысловая сверка выполнена отдельно.

Уточнение 14.09.2026

Docs/development/audit-remediation.md и прежний development-документ о SDD lifecycle отсутствуют. Не восстанавливать эти страницы и не обновлять WL-P2-13 как prerequisite; текущие docs объясняют систему, история поставок остаётся в Git.
HTTP API, ADR 014, правила docs.

## Задача Обновить объяснение workspace-команд и доставки OpenAPI по мере фактической реализации [main #4](https://git.personal.ksv741.ru/WealthLedger/main/issues/4) и [backend #3](https://git.personal.ksv741.ru/WealthLedger/backend/issues/3). ## Критерии готовности - [ ] Описаны только реально поставленные команды и их prerequisites, scope и ограничения. - [ ] Update и read-only verify OpenAPI различаются; frontend принимает предоставленный snapshot согласно ADR 014 и не требует backend checkout для своего verify. - [ ] Согласованы инструкции полного backend gate, specs verify и root runner; подробности команд остаются у repo owners. - [ ] Выбор и запись cross-repo revisions описаны в соответствии с [main #2](https://git.personal.ksv741.ru/WealthLedger/main/issues/2). - [ ] Ссылки и docs verify проходят; смысловая сверка выполнена отдельно. ## Уточнение 14.09.2026 Docs/development/audit-remediation.md и прежний development-документ о SDD lifecycle отсутствуют. Не восстанавливать эти страницы и не обновлять WL-P2-13 как prerequisite; текущие docs объясняют систему, история поставок остаётся в Git. [HTTP API](https://git.personal.ksv741.ru/WealthLedger/docs/src/commit/9b19a5cf4df5116c5f603f7189751d37ae9f0ffd/architecture/http-api.md), [ADR 014](https://git.personal.ksv741.ru/WealthLedger/docs/src/commit/9b19a5cf4df5116c5f603f7189751d37ae9f0ffd/adr/014-trusted-openapi-input.md), [правила docs](https://git.personal.ksv741.ru/WealthLedger/docs/src/commit/9b19a5cf4df5116c5f603f7189751d37ae9f0ffd/AGENTS.md).
ksv741 was assigned by codex-bot 2026-09-14 06:11:33 +03:00
codex-bot added the Kind/Documentation
Priority
Medium
3
Reviewed
Confirmed
1
labels 2026-09-14 06:12:47 +03:00
Author
Owner

Закрываем документационную задачу в согласованном обновлённом scope после merge docs PR #14, backend PR #19 и root PR #10.

Описаны существующие repo-owned команды и границы проверок. Backend предоставляет npm run openapi:generate без запуска HTTP-сервера, подключения БД и соседнего checkout; openapi.json игнорируется Git. Генерация/обновление и read-only проверка различаются, frontend проверяет предоставленный snapshot самостоятельно. Docs verify в изолированном checkout прошёл: 42 Markdown-файла, локальные ссылки и git diff --check; выполнена смысловая сверка инструкций.

Исходные требования общего root runner и cross-repo revisions отменены решением владельца об автономности репозиториев (main #4, main #2). Этот комментарий фиксирует изменение критериев, а не выполнение отменённых требований.

Закрытие документации не означает завершение всех критериев backend #3, в частности атомарной записи артефакта, или native OpenSpec validation из specs #2. Эти задачи остаются открытыми.

Закрываем документационную задачу в согласованном обновлённом scope после merge [docs PR #14](https://git.personal.ksv741.ru/WealthLedger/docs/pulls/14), [backend PR #19](https://git.personal.ksv741.ru/WealthLedger/backend/pulls/19) и [root PR #10](https://git.personal.ksv741.ru/WealthLedger/main/pulls/10). Описаны существующие repo-owned команды и границы проверок. Backend предоставляет npm run openapi:generate без запуска HTTP-сервера, подключения БД и соседнего checkout; openapi.json игнорируется Git. Генерация/обновление и read-only проверка различаются, frontend проверяет предоставленный snapshot самостоятельно. Docs verify в изолированном checkout прошёл: 42 Markdown-файла, локальные ссылки и git diff --check; выполнена смысловая сверка инструкций. Исходные требования общего root runner и cross-repo revisions отменены решением владельца об автономности репозиториев ([main #4](https://git.personal.ksv741.ru/WealthLedger/main/issues/4), [main #2](https://git.personal.ksv741.ru/WealthLedger/main/issues/2)). Этот комментарий фиксирует изменение критериев, а не выполнение отменённых требований. Закрытие документации не означает завершение всех критериев [backend #3](https://git.personal.ksv741.ru/WealthLedger/backend/issues/3), в частности атомарной записи артефакта, или native OpenSpec validation из [specs #2](https://git.personal.ksv741.ru/WealthLedger/specs/issues/2). Эти задачи остаются открытыми.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: WealthLedger/docs#4