banger/docs
Thales Maciel 88425fb857
docs: DNS routing guide; README aimed at common users
Adds docs/dns-routing.md covering how `<vm>.vm` resolution works:
auto-configuration on systemd-resolved hosts (what the daemon
already does), and per-resolver recipes for dnsmasq /
NetworkManager+dnsmasq / /etc/resolv.conf / macOS `/etc/resolver/`
/ WSL. Plus verification via `dig @127.0.0.1 -p 42069` and
troubleshooting for the common failure modes.

README reshape: lead with the three things a common user needs —
quick start, what `vm run` does, where to put hostnames + image +
config — and push the rest to docs. `vm create` / OCI `image pull`
/ `image register` / workspace-and-session primitives are all still
documented, just under docs/advanced.md where they're not in the
first-time reader's way. Web UI and unnecessary implementation
notes dropped; the "further reading" section at the bottom
enumerates the five docs pages so nothing becomes hard to find.

README shrinks from 208 → 158 lines.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-18 17:24:50 -03:00
..
reference Reorganize the source checkout layout 2026-03-21 17:22:57 -03:00
advanced.md docs: DNS routing guide; README aimed at common users 2026-04-18 17:24:50 -03:00
dns-routing.md docs: DNS routing guide; README aimed at common users 2026-04-18 17:24:50 -03:00
image-catalog.md docs: promote vm run + image catalog as the happy path 2026-04-18 15:33:30 -03:00
kernel-catalog.md Prune legacy void/alpine + customize.sh flows 2026-04-18 15:39:53 -03:00
oci-import.md Remove image build --from-image; doctor treats catalog images as OK 2026-04-18 15:54:29 -03:00