Sam Rolfe
eb300b6701
Phase 10 (the last phase of this project) is the project-docs pass. Update the Gitea README, add the Mermaid source and rendered PNG, build the interactive Archify map, add the Vikunja board tasks, and write the Outline AI-context collection in Simplified Technical English. Deliverables: - README.md: status header, Phase 4 gap statement, "Architecture" section with embedded Mermaid + image + Archify link, "Documentation set" table, an explicit two-plane MQTT section (1883 plain+anonymous, 8883 TLS+ACLs), and the Android client's Usage Access and VpnService paths. - AGENTS.md section 11: tick Phase 10, leave Phase 4 unticked, status line now "9 of 10 done - only Phase 4 outstanding". - docs/architecture.mmd + docs/diagrams/architecture.png (mmdc). - docs/archify/architecture.architecture.json + docs/architecture-map.html (Archify, showcase, 9/9 checks, 0 errors). - docs/outline/00-index.md .. 04-agent-runbook.md (STE). - docs/vikunja-tasks.json (Vikunja project "Internet Use Control", id 20). - Obsidian note written to 010 inbox on .27; the obsidian-sorter proposed a folder and waits for the vault owner's approval. Phase 4 (Python Windows computer client) is deliberately deferred and is NOT built. Every document says so. Co-Authored-By: Paperclip <noreply@paperclip.ing>
48 lines
2.3 KiB
Markdown
48 lines
2.3 KiB
Markdown
# 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`.
|