docs(iroh-net): Link to Endpoint in the first few paragraphs #2875
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 Endpoint is the central struct. I think it should be linked really early on as the most obvious link to follow. I myself rely on this link being at the start of docs page, but introducing this early example moved it down rather far. So move it back up.
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2875/docs/iroh/ Last updated: 2024-10-31T10:31:44Z |
Arqu
approved these changes
Oct 31, 2024
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.
Description
The Endpoint is the central struct. I think it should be linked
really early on as the most obvious link to follow.
I myself rely on this link being at the start of docs page, but
introducing this early example moved it down rather far. So move it
back up.
Breaking Changes
Notes & open questions
Change checklist