BridgeSwarm/docs/living/README.md

Living docs

These files track what BridgeSwarm is today, what the local Holepunch tree implies, and what to build next. Update them in the same PR as code changes. Static references in docs/*.md stay the public API; this folder is the working notebook.

Doc	Purpose
STATUS.md	Inventory of what ships and what was completed in the latest pass
PLAN.md	Ordered plan to continue development
HOLEPUNCH.md	How Holepunch modules actually work vs how BridgeSwarm uses them
GAPS.md	Remaining gaps after the latest pass (not forgotten TODOs)

How to maintain

1. If you add a host command, pack, or page helper — update STATUS, the matching docs/*.md reference, and trim GAPS.
2. If you decide not to build something — move it from PLAN “now” to GAPS “wontfix / later” with a reason.
3. Re-read the local clone at /Volumes/storage/dev/pearcli/holepunch-repos/holepunchto_repos when bumping Hyper* majors; refresh HOLEPUNCH.md.

Last reviewed: 2026-08-12.