pastilhasandClaude Opus 5
04c0d89057
First pass of the documentation audit. Every doc was read against what the code actually does now; this commit fixes the ones worth keeping and deletes the ones that were only describing a past. Corrected: - CLAUDE.md — said seven WebSocket providers (there are eight, and terminal/vault are byte relays now, not translating bridges), listed channels/ as "Telegram / WhatsApp / Discord bridges" (they are gone; what remains is how /chat drives an agent turn), missed officer-wallet in the PM2 list and notify/ in the layout, and described the per-account email SQLite stores without saying they are the sidecar's and that nothing in the platform opens them. Further Reading pointed at four files that no longer exist and missed the four newest. - docs/working-on-officer.md — PM2 list was four sidecars short, and it still explained the officer-claude rename as news. Replaced with the thing a reader actually needs: which process to restart for which change, and why restarting officer no longer costs you a terminal or an agent session. - TODO.md — the "dead username plumbing" item was mostly resolved by deleting the channels, and two email items pointed at api/email/email-db.ts, which is sidecar/email/store.ts now. - AGENTS.md — trailing paragraph listed the design notes being deleted here. - MUSIC_API.md — playlists were entirely undocumented: seven endpoints the phone app has no reference for. Added from the sidecar's own contract. - docs/jobs-unification.md — phases 1-3 shipped, so it now says so at the top. Phase 4 (push notifications) is the only reason the file still exists, and email sync is explicitly no longer part of it. Deleted, all superseded rather than merely old: - PHONE_APP.md — a February plan for apps that now exist, with their own repo and README. - MARKETING_WEBSITE.md — a plan for a site this repo does not contain. - SECURITY_AUDIT.md + SECURITY_FIXES.md — a February audit of a codebase since restructured; it still cites queue/handlers, which is now empty. - docs/DOCKERIZATION_PLAN.md — cites pty-sidecar, whatsapp and projects, all deleted. - SETUP_GUIDE.md — documents systemd units and setup scripts replaced by PM2 and `bun setup`. Not harmless: /etc/systemd/system/officer-pty-sidecar.service is still enabled on this host, pointing at a `monorepo/` directory that no longer exists, and has been failing to start ever since. That guide is how it got there. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
31 lines
1.6 KiB
Markdown
31 lines
1.6 KiB
Markdown
# AGENTS.md
|
|
|
|
Guidance for any coding agent working in the Officer platform repo.
|
|
|
|
**The instructions live in [`CLAUDE.md`](CLAUDE.md). Read it first — this file only points there.**
|
|
|
|
Kept separate so agents that look for `AGENTS.md` by convention find the same guidance as those that
|
|
look for `CLAUDE.md`, without the two drifting apart. The previous contents of this file had drifted
|
|
badly: they described Officer as a multi-user intranet for small businesses, with a user-invitation
|
|
API, a `bun dev` serving a separate dashboard on port 5000, and a closing instruction to be
|
|
"multi-user aware — always consider user isolation and role-based access". None of that is true.
|
|
|
|
## Orientation
|
|
|
|
Officer is a self-hosted personal platform that **serves exactly one person — the owner of the
|
|
server**. There is no tenancy, no roles, no user management. If a design question turns on "which
|
|
user", the answer is the owner.
|
|
|
|
This repo is one of two. The other, `capabilities/`, holds the agent's tasks, tools and skills as
|
|
plain files, and is where most changes belong — adding or changing a task needs no code change here
|
|
and no restart.
|
|
|
|
- [`CLAUDE.md`](CLAUDE.md) — this repo's architecture, conventions and code style
|
|
- [`docs/working-on-officer.md`](docs/working-on-officer.md) — the deployment-wide guide: which
|
|
directory a change belongs in, how to run and verify it, the task system, and the failure modes
|
|
worth knowing about
|
|
- `CONVENTIONS.md` — component organisation and React patterns, with rationale
|
|
- `TODO.md` — current direction; takes precedence where it disagrees with anything else
|
|
|
|
Treat the code as the source of truth where anything disagrees with it.
|