Add full documentation: MkDocs setup, API reference, user guide, deployment guide
Some checks failed
Build and Push Docker Image / build-and-push (push) Failing after 55s
Some checks failed
Build and Push Docker Image / build-and-push (push) Failing after 55s
This commit is contained in:
34
docs/index.md
Normal file
34
docs/index.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Work Queue WebUI
|
||||
|
||||
A web interface for managing TheLab's distributed work queue system. It connects to the [Work Queue API](https://git.danhenry.dev/thelab/work-queue-api) and presents queue state in real time.
|
||||
|
||||
## Overview
|
||||
|
||||
The Work Queue WebUI provides a visual interface for monitoring and managing work items dispatched to agents across TheLab's infrastructure.
|
||||
|
||||
## Features
|
||||
|
||||
- Real-time queue status monitoring
|
||||
- Agent activity tracking
|
||||
- Work item lifecycle visibility
|
||||
- Project-based work organization
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Open the WebUI in your browser (default: `http://localhost:8081`)
|
||||
2. View active work items and their current status
|
||||
3. Monitor agent activity and queue depth
|
||||
|
||||
## Architecture
|
||||
|
||||
The WebUI is a React frontend that communicates with the Work Queue API backend. It polls for updates and displays the current state of all queued, in-progress, and completed work items.
|
||||
|
||||
```
|
||||
Browser → Work Queue WebUI → Work Queue API (app-01:8080) → PostgreSQL
|
||||
```
|
||||
|
||||
## Related
|
||||
|
||||
- [Work Queue API](https://git.danhenry.dev/thelab/work-queue-api)
|
||||
- [Deployment Guide](./deployment.md)
|
||||
- [API Reference](./api.md)
|
||||
Reference in New Issue
Block a user