[Privacy Pass] Fix docs style warnings and suggestions#32188
Draft
gsebb wants to merge 2 commits into
Draft
Conversation
Address linter warnings and suggestions across the Privacy Pass docs: - Remove contraction and trailing punctuation in headings - Capitalize Internet as a proper noun - Add Oxford comma - Replace 'see [link]' phrasing with 'refer to' - Replace directional wording with a direct reference - Wrap the TypeScript sample in <TypeScriptExample> for an auto-generated JS tab
- Remove <TypeScriptExample> wrappers so TypeScript samples render as plain code blocks, consistent with the other code blocks in the docs - Rework the 'maps to the four roles' example: split the interleaved diagram and code into a standalone boxed sequence diagram and a separate, annotated TypeScript block - Clarify two step annotations in the example
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
2 participants
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.
Summary
Address linter warnings and suggestions across the Privacy Pass docs:
Additional changes:
Documentation checklist