docs: refresh the readme and cli help for invitations - #12
Merged
Conversation
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
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.
Catches the README and
--helpup with what shipped in #10 and #11.CLI
--helpstill opened with "What happens when you want dumbpipe to stay running,handle a few ports at once, and reconnect when your laptop wakes up", a tagline
the README replaced a while ago. Now
-hgives a one-line summary and--helpgives the README's opening, including the sentence that matters most: access is
default deny and per peer.
Command descriptions were written when the commands were named differently.
exposesaid "Expose a port to specific peers (a directed grant)", whichexplains the mechanism to someone who already knows it. It now says nothing is
reachable without a grant.
projectnow leads with the fact that peers areprojected automatically, so you only need it to pin an address or rename one.
Two help strings still said "enrollment label".
README
Three things were stale:
it is the name you gave it, or a short form of its key.
pai-sho expose 3002 --to <laptop-key>, asking thereader for a key the example never gave them. It is
--allnow, with a linesaying what
--alldoes and does not mean.One thing was missing. The README described a single shape: an operator with
workloads that phone home. That was accurate before, but the invite/accept work
was driven by the other shape, two long-lived machines where the provider
invites and the consumer names. The intro now says a link is mutual and works
either way, and a new More section points at
docs/scenarios.md, which wasnot linked from anywhere.
On the ordering
I looked at whether Example should move below Install, since it opens with "the
daemon is already running on its own network interface". It already links both
Install and Setting up the network in that sentence, so a reader who needs setup
can get there. Leading with the example is the right call for this project.
Left as is.