docs: document exhaustive Brencher use cases #80

Merged
admin merged 6 commits from hermes/brencher:docs/exhaustive-use-cases into main 2026-10-05 20:49:00 +02:00
Contributor

Summary

  • disable the admin/brencher remote for the main brencher profile
  • document backend/API use cases in docs/USE_CASES_BACKEND.md
  • document UI/state use cases in docs/USE_CASES_UI.md
  • preserve the application goal section in both documents
  • document the actual boundary: REST is read-only (/state, /branches); mutations are currently sent through /ws

Verification

  • git diff --check
  • python3 -m compileall -q backend
  • backend scenarios: B-01..B-19
  • UI scenarios: U-01..U-21
  • main profile no longer contains admin/brencher; brencher2 remains unchanged

Notes

The PR head is hermes/docs/exhaustive-use-cases and the target is admin/main.

## Summary - disable the `admin/brencher` remote for the main `brencher` profile - document backend/API use cases in `docs/USE_CASES_BACKEND.md` - document UI/state use cases in `docs/USE_CASES_UI.md` - preserve the application goal section in both documents - document the actual boundary: REST is read-only (`/state`, `/branches`); mutations are currently sent through `/ws` ## Verification - `git diff --check` - `python3 -m compileall -q backend` - backend scenarios: `B-01..B-19` - UI scenarios: `U-01..U-21` - main profile no longer contains `admin/brencher`; `brencher2` remains unchanged ## Notes The PR head is `hermes/docs/exhaustive-use-cases` and the target is `admin/main`.
hermes added 1 commit 2026-10-02 01:20:18 +02:00
docs: document exhaustive Brencher use cases
Python package / build (3.12.3) (pull_request) Canceled after 2m11s
Python package / build (3.13) (pull_request) Canceled after 0s
Python package / build (3.14) (pull_request) Canceled after 0s
16b6114eca
hermes added 1 commit 2026-10-02 01:22:33 +02:00
docs: complete API and health-check use cases
Python package / build (3.12.3) (pull_request) Canceled after 1m32s
Python package / build (3.13) (pull_request) Canceled after 0s
Python package / build (3.14) (pull_request) Canceled after 0s
e24b5c12ae
hermes added 1 commit 2026-10-02 01:24:06 +02:00
docs: refine operational use cases
Python package / build (3.12.3) (pull_request) Successful in 2m33s
Python package / build (3.13) (pull_request) Successful in 2m26s
Python package / build (3.14) (pull_request) Successful in 2m39s
acf99df75b
USE_CASES.md Outdated
@@ -0,0 +31,4 @@
3. Через 5 секунд интерфейс повторяет подключение.
4. После подключения сервер снова отправляет полное состояние.
### UC-03. Посмотреть версию приложения
Owner

Версия чего отображается

Версия чего отображается
hermes added 1 commit 2026-10-05 16:15:39 +02:00
docs: split backend and UI use cases
Python package / build (3.12.3) (pull_request) Canceled after 2m28s
Python package / build (3.13) (pull_request) Canceled after 0s
Python package / build (3.14) (pull_request) Canceled after 0s
572cd56cac
hermes added 1 commit 2026-10-05 16:18:10 +02:00
docs: move use cases into docs directory
Python package / build (3.12.3) (pull_request) Successful in 2m44s
Python package / build (3.13) (pull_request) Successful in 2m31s
Python package / build (3.14) (pull_request) Successful in 2m37s
c3e81b75c8
hermes added 1 commit 2026-10-05 19:58:59 +02:00
docs: record use cases without test coverage
Python package / build (3.12.3) (pull_request) Successful in 2m44s
Python package / build (3.13) (pull_request) Successful in 2m41s
Python package / build (3.14) (pull_request) Successful in 2m36s
ab50d5dbee
admin merged commit f70c0a1d12 into main 2026-10-05 20:49:00 +02:00
admin deleted branch docs/exhaustive-use-cases 2026-10-05 20:49:01 +02:00
Sign in to join this conversation.
No Reviewers
No labels
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: admin/brencher#80