Files
svc-gw/docs/GUIDELINES.md
T
mikkeli 8a10b2f6c0 Adopt designed front matter: typed, with staleness on plans
Replaces `type: default` — one value across every document, read by nothing,
so it discriminated nothing. Types are now reference, guidelines, plan and
report, applied to every markdown file with no exceptions for the hub.

Plans carry status and updated, reports carry date. REPOS.md already noted
that plans go stale and reports do not, but nothing made that visible: a plan
from months ago looked identical to one written today.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013kj58Jugkic783b8ZrtTVZ
2026-09-04 14:14:18 +09:00

555 B

type
type
guidelines

Gateway guidelines

1. Read-only with respect to acquisition

  • The gateway subscribes. It never opens a CAN socket, TX-capable or otherwise.
  • obd-poller is the single writer on the bus. Nothing here changes that.

2. Aggregate, do not relay

  • A 500 kbps CAN bus produces far more traffic than a display can use or a USB link should carry. Downsample and summarise here.
  • If the gateway is only forwarding a topic unchanged, that client should have subscribed to the broker directly instead.

3. To be added