From e510e8382d39650c414ab83cbc80527917d886ac Mon Sep 17 00:00:00 2001 From: twilightsaurus Date: Mon, 5 Oct 2026 18:47:13 +0300 Subject: [PATCH] docs: refresh project context --- AGENTS.md | 12 +++++++----- README.md | 2 +- deploy/README.md | 2 +- docs/roadmap.md | 28 ++++++++++++++-------------- 4 files changed, 23 insertions(+), 21 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 5a1f422..278b822 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,8 +1,9 @@ # Imp - agent guide -Imp is a small always-on-top companion HUD for MUDs. It reads character -vitals from a TinyFugue session on a remote VPS and renders them in a compact -frameless desktop window. +Imp is a small always-on-top companion HUD for MUDs. Supported MUD-client +adapters attach to same-host Imp nodes, publish client-neutral normalized +state, and handle exact-context trusted actions. The desktop HUD can consume a +local node or reach a remote node through SSH or authenticated WSS. ## Start here @@ -43,8 +44,9 @@ changing, then the source it cites. the same commit, or the conformance tests will fail - that tripwire is intentional. - `npm run check` is the platform-independent gate: lint/docs/version checks, - TypeScript typechecks and tests, relay and TinyFugue lint/tests, the - cross-component end-to-end check, and the frontend production build. + TypeScript typechecks and tests, relay/shared-adapter/Mudlet/TinyFugue Python + lint, type checks, and tests, the cross-component end-to-end check, and the + frontend production build. - Conventional Commits are release inputs, not just style. `fix:` is a patch, `feat:` is a minor increment, and an explicit breaking change is a major increment. While Imp is `0.x`, a normal `feat:` advances the minor version diff --git a/README.md b/README.md index 798b232..73fc2b1 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Imp is a compact desktop companion for MUDs. It displays live character state from your MUD client, provides configurable alerts, and lets you define trusted action shortcuts. -The latest published release (`v0.2.1`) ships with: +Current published release artifacts include: - a Windows x64 desktop installer, including the desktop-owned local Imp node and Mudlet helper/package; diff --git a/deploy/README.md b/deploy/README.md index 8ca5091..c597413 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -25,7 +25,7 @@ untrusted multi-user hosts are unsupported. The normal server installation does **not** require an Imp source checkout, Node.js, npm, Rust, or `uv` on the VPS. -The latest published server bundle (`v0.2.1`) supports: +The published Linux server bundle supports: - Linux x86_64; - CPython 3.12; diff --git a/docs/roadmap.md b/docs/roadmap.md index 97ef4ba..66130bf 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -35,13 +35,13 @@ claims belong in `status.md` and the relevant architecture documents. | Slice 15 - Server installation / bootstrap | ✅ Complete | `server-install-bootstrap` | | Post-Slice 15 - Public release and release automation | ✅ Complete | `v0.1.0`; later work untagged | | Slice 16 - Mudlet and local client integration | ✅ Complete | Untagged; slug below | -| Slice 17 - Input boundary correctness | Complete | Untagged | -| Slice 18 - Freshness correctness | Complete | Untagged | -| Slice 19 - Subscriber isolation | Complete | Untagged | -| Slice 20 - Diagnostic hardening | Complete | Untagged | -| Slice 21 - Native runtime ownership | Complete | Untagged; platform limits below | -| Slice 22 - Client-neutral UI and docs polish | Complete | Untagged | -| Slice 23 - ActionBroker timeout validation | Complete | Untagged | +| Slice 17 - Input boundary correctness | Complete | `input-boundary-correctness` | +| Slice 18 - Freshness correctness | Complete | `freshness-correctness` | +| Slice 19 - Subscriber isolation | Complete | `subscriber-isolation` | +| Slice 20 - Diagnostic hardening | Complete | `diagnostic-hardening` | +| Slice 21 - Native runtime ownership | Complete | `native-runtime-ownership` | +| Slice 22 - Client-neutral UI and docs polish | Complete | `client-neutral-ui-docs` | +| Slice 23 - ActionBroker timeout validation | Complete | `actionbroker-timeout-validation` | Slice numbers and milestone tags are development-history markers. They have no relationship to release versions. Release versions are derived independently @@ -588,7 +588,7 @@ raw/ANSI GMCP robustness remain separate candidate work. ### Slice 17 - Input boundary correctness -Slug: `input-boundary-correctness`. Complete; untagged. +Milestone tag: `input-boundary-correctness`. Complete. Remediates F01, F06, and F07 from the [full repository audit](audits/2026-10-03-full-repository-audit.md): @@ -606,7 +606,7 @@ outside this slice. ### Slice 18 - Freshness correctness -Slug: `freshness-correctness`. Complete; untagged. +Milestone tag: `freshness-correctness`. Complete. Remediates F02 through shared canonical-observation classification and the existing matching-context publication path. Unchanged valid observations keep @@ -620,7 +620,7 @@ outside this slice. ### Slice 19 - Subscriber isolation -Slug: `subscriber-isolation`. Complete; untagged. +Milestone tag: `subscriber-isolation`. Complete. Remediates F03 with one serialized writer and a bounded 16-frame FIFO per subscriber. Broadcast enqueues without awaiting network sends; overflow or a @@ -634,7 +634,7 @@ protocol changes, or other audit remediation is included. ### Slice 20 - Diagnostic hardening -Slug: `diagnostic-hardening`. Complete; untagged. +Milestone tag: `diagnostic-hardening`. Complete. Remediates F04/F11: relay/gateway-owned WebSocket connections explicitly use a credential-safe logger with an INFO floor and monotonic severity restrictions, @@ -649,7 +649,7 @@ policy, freshness, subscriber isolation, and other audit findings are unchanged. ### Slice 21 - Native runtime ownership -Slug: `native-runtime-ownership`. Complete within the supported platform contract; untagged. +Milestone tag: `native-runtime-ownership`. Complete within the supported platform contract. Addresses F05 for the Windows release target with atomic child Job Object membership and kernel kill-on-final-handle-close for owned node, gateway, and @@ -674,7 +674,7 @@ not claimed. Evidence and explicit limitations are in [`status.md`](status.md). ### Slice 22 - Client-neutral UI and docs polish -Slug: `client-neutral-ui-docs`. Complete; untagged. +Milestone tag: `client-neutral-ui-docs`. Complete. Remediates F08–F10: client-neutral shared action/offline feedback, labelled native segmented radios with standard keyboard selection and visible focus, @@ -688,7 +688,7 @@ Slice 22 alone did not claim closure of the full audit; the separate ### Slice 23 - ActionBroker timeout validation -Slug: `actionbroker-timeout-validation`. Complete; untagged. +Milestone tag: `actionbroker-timeout-validation`. Complete. Resolves the separately deferred timeout-validation gap, not an F01–F11 finding. The broker constructor requires a finite, strictly positive result timeout and