docs: link the wiki from the README#8
Merged
Merged
Conversation
The wiki now carries the user-facing documentation the README has no room for: installation, the two-machine pairing walkthrough, firewall/DNS setup, the config and CLI reference, troubleshooting, and a Not-Yet-Implemented page that records what is advertised but not built. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
xeri
added a commit
that referenced
this pull request
Jul 16, 2026
The wiki now carries the user-facing documentation the README has no room for: installation, the two-machine pairing walkthrough, firewall/DNS setup, the config and CLI reference, troubleshooting, and a Not-Yet-Implemented page that records what is advertised but not built. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
xeri
added a commit
that referenced
this pull request
Jul 16, 2026
The wiki now carries the user-facing documentation the README has no room for: installation, the two-machine pairing walkthrough, firewall/DNS setup, the config and CLI reference, troubleshooting, and a Not-Yet-Implemented page that records what is advertised but not built.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The wiki is now written — 15 pages covering installation, the two-machine pairing walkthrough, networking/firewall and DNS, tunnels, the GUI, the Windows service, the config and CLI reference, the security model, privacy, and troubleshooting, plus a light Architecture and Contributing page.
This PR is the one-line pointer to it from the README.
Two things the wiki deliberately does not do:
internal/doccheck's citation gate, so numbers copied into it would rot silently. It citesdocs/agent/architecture.md's numbers table instead.per-conn, UDP, tray/autostart, Linux/macOS) so users don't debug features that were never built.Follow-up, not in this PR
While writing the wiki I verified the Reality check against the code — every row holds — and found three further inaccuracies in the README/CLI that are worth a separate fix:
--headlessis a no-op: bound by the flag, never read. Theagent/gatewaysubcommands are always headless.service install --role gatewaydoes not exist —newServiceCmdregisters zero flags; the role comes from the config file.YOUR-PUBLIC-ADDRESS, even whengateway.public_hostis set — only the GUI substitutes the real host.Also: the README's Download section links to a release, but no tag has ever been cut, so that link 404s today.
🤖 Generated with Claude Code