c5760db43d
- README: architecture Mermaid, Phase 8 status, Phase 7 endpoints, Documentation index - docs/outline/: AI-context collection (index, system, config, code map, runbook) - docs/email-agent-architecture.mmd + rendered PNG + Archify map (showcase pass) - docs/vikunja-tasks.json (Vikunja project 17, tasks 179-185) - docs/phase8-documentation.md evidence
45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
# Email Agent — AI Document Index
|
|
|
|
> **Target**: AI agents.
|
|
> **Writing style**: ASD-STE100 Simplified Technical English.
|
|
|
|
## Document catalog
|
|
|
|
Read this index. Inject the exact document you need. Do not search all files.
|
|
|
|
| Document | Path | Scope |
|
|
| :--- | :--- | :--- |
|
|
| **System Overview** | `docs/outline/01-system-overview.md` | Purpose, architecture, services, phase status. |
|
|
| **Configuration and Environment** | `docs/outline/02-config-and-env.md` | Environment variables, config paths, ports, secrets. |
|
|
| **Code Map** | `docs/outline/03-code-map.md` | Folder structure, entry points, dependencies, schema. |
|
|
| **Agent Runbook** | `docs/outline/04-agent-runbook.md` | Commands to test, deploy, restart, and roll back. |
|
|
|
|
The build spec is `AGENTS.md`. The phase evidence files are `docs/phaseN-*.md`.
|
|
The interactive map is `docs/email-agent-map.html`.
|
|
|
|
## System summary
|
|
|
|
The Email Agent triages the family inbox. All mail lands in one Gmail account.
|
|
Sam opens one page, clears the inbox in minutes, and sees nothing important
|
|
missed. The service reads Gmail over IMAP, classifies each message with JEV,
|
|
recommends an action, applies bulk actions, drafts replies, and answers the Hub.
|
|
|
|
## Core configuration
|
|
|
|
- **Secrets file**: `~/.config/environment.d/10-secrets.conf` (mode 600).
|
|
- **Project directory**: `/home/sam/paseo/projects/email_agent/`.
|
|
- **Live host**: `.13`, one container, own image.
|
|
- **Live port**: `8790`. Public URL: `https://mail.lab.audasmedia.com.au`.
|
|
- **Database**: SQLite at `/data/email_agent.db` on the `email_agent_data` volume.
|
|
|
|
## Agent restart steps
|
|
|
|
1. Read the catalog above. Inject only the documents you need.
|
|
2. Check git status: `git status`.
|
|
3. Check recent commits: `git log -n 5 --oneline`.
|
|
4. Run the Go tests in a container:
|
|
|
|
```sh
|
|
timeout 600 docker run --rm -v "$PWD":/src -w /src golang:1.25-alpine go test ./...
|
|
```
|