Repository navigation
docs: fix typos and clarity - #181
Merged
Merged
Conversation
The README said the sample systemd and launchd files are under `examples`, but the directory is `example/`, so name it correctly and link it. The Windows note linked to /guides/wg-clients, a docs site route that 404s on GitHub, so use the absolute nylon.jq.ax URL like the README's other docs links.
The config distribution section said to put the bundle URL in the node config under `dist/url`, which node.yaml no longer accepts, and that nylon downloads the config before starting up. It also said `nylon seal` uses the public key, when it reads the private key from `central.key`. List the URL under `dist.repos` in central.yaml, say that every node still needs central.yaml before its first start, link the config distribution guide, and write `dist.key` as that guide does. The last tip said to run `nylon i`, which no longer exists. Point to `nylon status -i <interface_name>`, and say what --routes and --full add to its output.
The comment on the sample's `type: http` prefix compared it to itself; it means the ping check above it. The url comment said only that the check expects a success response, but anything other than HTTP 200 is a failure. Unlike ping there is also no max_failures: any failed request stops advertising the prefix until the next successful one.
`nylon run --json` only changes the console log on stderr; the log file stays in text format. `nylon open` prints the parsed config to stderr too, and stdout stays empty. The help text said neither.
Owner
|
lgtm! |
encodeous
approved these changes
Nov 3, 2026
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.
Went though some of the documentation and comments and noticed some out of date things/typos:
Please let me know if I misconstrued some of the documentation. I did some digging and this all lines up with my mental model and local network.