Explain NXS in plain English and add writing guidance - #11
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
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 NXS spec introduced protocol fields before explaining how a connection works. This rewrite starts with a short example, defines the key terms, and groups the rules by the task an implementer needs to perform. It also explains the separate roles of machine signing keys, DTLS certificates, and admission keys.
The README links to a short writing checklist based on Google's technical-writing course and Microsoft's style guide. The checklist includes before-and-after examples for future docs and PR descriptions.
Validation: reviewed the rules against the original; checked field names, signing formulas, numeric limits, binary token layout, and local links. The protocol fixture verifier and
git diff --checkpass. Code, schemas, fixtures, and dependency pins are unchanged.This docs-only PR targets
nxs-dev. The aggregate upstream proposal remains unmerged.