# Internet Use Control — AI Document Index

> **Target**: AI agents.
> **Writing style**: ASD-STE100 Simplified Technical English (`ste-writing`).

## Document Catalog (inject the exact file)

Read this index. Then inject only the file that you need. Do not search all files.

| Document Title | Path | Scope / Description |
| :--- | :--- | :--- |
| **System Overview** | `docs/outline/01-system-overview.md` | States the purpose, the components, the MQTT planes and the missing Phase 4 client. |
| **Configuration and Env** | `docs/outline/02-config-and-env.md` | Lists the environment variables, the config files, the ports and the secrets. |
| **Code Map** | `docs/outline/03-code-map.md` | Shows the folder tree, the entry points and the Go dependencies. |
| **Agent Runbook** | `docs/outline/04-agent-runbook.md` | Gives the commands to build, test, deploy, verify and resume work. |

## Source Documents (read before the outline)

| Document | Path | Scope |
| :--- | :--- | :--- |
| **Build spec** | `AGENTS.md` | The phases and the definition of done. Section 11 holds the phase checklist. |
| **System map** | `SYSTEM_MAP.md` | Names every component and states where the truth lives. |
| **Transport design** | `TRANSPORT_DESIGN.md` | The MQTT topics, the payloads, the security rules and the fail-safe rule. |
| **README** | `README.md` | The technical reference. Setup, endpoints, payloads and verification. |

## System Summary

The Control Service limits the screen use of two children. It holds weekly
schedules, blocklists, allowlists and usage in SQLite. It publishes the desired
state of each device to MQTT with the retained flag. It serves an HTMX dashboard,
a versioned admin API and a read-only Hub API.

## Core Configuration

- **Env file**: `environment.d/control-service.env` (gitignored).
- **Template**: `environment.d/control-service.env.example`.
- **Live port**: `8791` on `.13`.
- **Public URL**: `https://webrestrict.lab.audasmedia.com.au`.
- **State**: SQLite at `/data/control.db` inside the container.

## Agent Restart Steps

1. Read the Document Catalog above. Inject only the required file.
2. Read `AGENTS.md` section 11. Confirm the phase checklist.
3. Check the tree state: `git status`.
4. Check the recent commits: `git log -n 5 --oneline`.
5. Run the test suite: `make test`.
