Files

Sam Rolfe b4bbd6d3f9 Phase 9: publish the documentation set (README, map, Outline, Vikunja)

- README: Phase 9 status, the architecture diagram + map link, and the
  explicit "Teams (FR-15) is DEFERRED" statement.
- docs/architecture.mmd + docs/diagrams/architecture.png (mmdc).
- docs/archify/architecture.architecture.json -> docs/architecture-map.html
  (Archify showcase, 9/9 checks).
- docs/outline/: the five AI-context documents (STE style).
- docs/vikunja-tasks.json: the live Vikunja board (project 21).

Co-Authored-By: Paperclip <noreply@paperclip.ing>

2026-10-15 20:00:23 +11:00

1.8 KiB

Raw Blame History

Compass NHS — AI Document Index

Target: AI Agents Writing Style: ASD-STE100 Simplified Technical English.

Document Catalog (Inject Specific Document)

Read this index first. Inject the exact file you need. Do not search every file.

Document Title	Path	Scope
System Overview	`docs/outline/01-system-overview.md`	States the purpose, the main parts and the live services.
Configuration and Environment	`docs/outline/02-config-and-env.md`	Lists variables, paths, ports and secrets.
Code Map	`docs/outline/03-code-map.md`	Shows the folder layout, entry points and dependencies.
Agent Runbook	`docs/outline/04-agent-runbook.md`	Gives the commands to build, test, deploy and restart.

System Summary

This project reads the school systems for two children, Harry and Finn. It stores what is due, finds overdue work, writes important events to the family calendar, and sends morning briefs.

The service is one Go binary with SQLite. It runs in its own container on .13, port 8792, behind Caddy on .35 at school.lab.audasmedia.com.au.

Teams (FR-15) is DEFERRED. The project does not scan Teams. Compass answers what is due and overdue.

Core Configuration

Env File: environment.d/school-service.env (gitignored)
Env Example: environment.d/school-service.env.example
Config Code: internal/config/
Active Ports: 8792 (service), 8210 (Apprise on .35), 8788 (Hub)
Database: SQLite in the Docker volume compass-teams-nhs-data

Agent Restart Steps

Read the Document Catalog above. Inject only the required files.
Check the checkout: git status.
Read the recent history: git log -n 5 --oneline.
Run the checks: make test and make verify-phase8.
Read the current state: curl -s http://127.0.0.1:8792/health.

1.8 KiB Raw Blame History