DOCS(dev): Clean up network protocol docs #6714
Merged
Conversation
This file contains 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
The cross-document reference apparently worked on readthedocs (our previous docs), but does not work on GitHub. The cross-document figure reference is replaced with a file reference.
The figure follows below the paragraph.
1 task
Krzmbrzl
approved these changes
Jan 27, 2025
Kissaki
added a commit
that referenced
this pull request
Jan 27, 2025
Convert our network protocol docs from rst (ReStructuredText) to md (Markdown) format. --- This changeset is a followup to PR #6623. In that PR, which first integrated these docs into this repository, the comments indicated consensus that the docs should be in Markdown format to match our other docs. This changeset is based on PR #6714, which does some baseline corrections, and which should be merged first. --- Two tables are not converted to Markdown tables because they are not flat tables, which is hard, if not impossible, to represent in Markdown. Preformatted code blocks are being used for them instead. Otherwise, the conversion seems straightforward. The changeset includes individual commits by change type, so each kind of change can be traced. The first commit is purely a rename to ensure Git follows the content history across the file conversion.
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.
These changes can be considered a follow-up or fixup to PR #6623, which integrated the network protocol docs into this repository.
Checks