Files
Toju/agents-docs/FEATURES.md
brogeby b19c39208c docs: populate initial cross-context feature docs
Add area-level documentation for the five most significant cross-context
feature areas under agents-docs/features/:

- websocket-envelopes: full envelope catalogue, lifecycle, dispatcher
- ipc-bridge: window.electronAPI surface, IPC channels, CQRS dispatch
- plugin-system: manifest contract, runtime, capabilities, plugin-support API
- server-directory: REST endpoints, CQRS, entities, business rules
- voice-signaling: mesh signaling, RNNoise pipeline, domain split

Update agents-docs/FEATURES.md index alphabetically and remove the
"no cross-context feature docs" placeholder.

Each doc records honest TODOs for verified gaps (stale signaling-contracts.ts,
window.api vs window.electronAPI mismatch, IPC error envelope drift from
CONTEXT.md, missing OpenAPI coverage for server-directory routes, no
envelope round-trip test).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-25 15:36:36 +02:00

2.0 KiB

Feature Areas

This index represents the known feature areas in the system.

It must stay accurate as new features are introduced, renamed, merged, or removed.


Feature list (alphabetical)

  • ipc-bridge — Electron preload window.electronAPI surface, IPC channels, and CQRS dispatch.
  • plugin-system — Plugin manifest contract, renderer runtime, capability grants, and server plugin-support API.
  • server-directory — REST surface for server catalog, invites, join requests, and moderation.
  • voice-signaling — WebRTC mesh signaling, RNNoise pipeline, and voice / direct-call / screen-share orchestration.
  • websocket-envelopes — Wire-format contract for every realtime envelope between server and clients.

The product client already documents its bounded contexts at toju-app/src/app/domains/<name>/README.md (Access Control, Attachment, Authentication, Chat, Direct Call, Direct Message, Experimental Media, Game Activity, Notifications, Plugins, Profile Avatar, Screen Share, Server Directory, Theme, Voice Connection, Voice Session). Those domain READMEs cover internal product-client behavior.

agents-docs/features/<slug>.md is for cross-context contracts and feature areas that span more than one subdomain — WebSocket envelopes, IPC channels, plugin manifests, end-to-end flows that touch client + server + Electron together. Add an entry here the first time you write one.


Rules for agents

  • Introducing a new feature area requires:
    • creating agents-docs/features/<feature>.md (use agents-docs/features/feature-template.md)
    • adding it to this list (alphabetical)
  • Renaming or merging features requires updating links and notes
  • If the change is fully contained inside one product-client domain, prefer updating toju-app/src/app/domains/<name>/README.md over adding a top-level feature doc
  • This file should remain concise and navigable