Skip to content

docs(guides): DOC-02 - add admin coordinator guide#51

Merged
Killea merged 1 commit intoKillea:mainfrom
bertheto:docs/guide-admin-coordinator
Mar 8, 2026
Merged

docs(guides): DOC-02 - add admin coordinator guide#51
Killea merged 1 commit intoKillea:mainfrom
bertheto:docs/guide-admin-coordinator

Conversation

@bertheto
Copy link
Contributor

@bertheto bertheto commented Mar 8, 2026

Summary

  • New guide docs/guides/admin-coordinator.md documenting the background admin coordinator loop
  • Covers the full loop algorithm (10s polling, participant detection, timeout evaluation)
  • Documents 4 coordination scenarios (A: single admin takeover, B: multi-agent admin instruction, C: offline admin warning, D: admin switch confirmation)
  • Human decision REST API: GET /api/threads/{id}/admin and POST /api/threads/{id}/admin/decision
  • UI event types reference table with metadata fields and button specs
  • De-duplication and flood prevention mechanics explained
  • mkdocs.yml: adds Admin Coordinator nav entry after Agent Roles

Motivation

Completes DOC-02 from the Documentation epic. The admin coordinator loop is one of the more complex
subsystems. Agents and integrators need a clear reference for the scenarios, the system messages
emitted, and the human decision API consumed by the web UI.

Test plan

  • mkdocs build succeeds without warnings
  • Page renders correctly with Mermaid diagrams in MkDocs Material
  • All cross-links (thread-settings.md, agent-roles.md) resolve
  • Content reviewed against src/main.py _admin_coordinator_loop (L218-614)
  • Content reviewed against src/db/crud.py thread_settings_* functions

Related

- New guide: docs/guides/admin-coordinator.md
- Documents the background admin coordinator loop (10s polling,
  thread_wait_states_grouped, ThreadSettings integration)
- Covers 4 coordination scenarios (A: single admin takeover,
  B: multi-agent admin instruction, C: offline admin warning,
  D: admin switch confirmation)
- Documents human decision REST API: GET/POST /api/threads/{id}/admin
- UI event types reference table with metadata fields
- De-duplication and flood prevention mechanics
- Configuration cross-link to thread-settings guide
- mkdocs.yml: add Admin Coordinator nav entry after Agent Roles
@Killea Killea merged commit ed87598 into Killea:main Mar 8, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants