docs(iroh-net): Update toplevel module documentation #2329
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
This updates the top-level docs for iroh-net to be a general overview of what the crate provides, since this is effectively the docs.rs landing page.
divagant-martian
requested changes
May 27, 2024
There was a problem hiding this comment.
A lot better.
My two comments:
- Mention of dns.
- There are a few commas missing, and I most likely didn't point them all. Risking being even more pedantic, here there is a small pdf about commas in english from some us university https://www.svsu.edu/media/writingcenter/activedocs/Using%20Commas%20Within%20Sentences.pdf in particular about subordinating conjunctions like when, as, if etc. These felt more in plsce to me so I, as a non-native english speaker, wanted to be sure. Please consider it an education resource for both more than me being a prick 😅
Co-authored-by: Divma <[email protected]>
flub
commented
May 28, 2024
- Use an explicit RelayUrl - Some rewording - Describe DNS node discovery
That's totally fine! Good resource. I also liked https://developers.google.com/tech-writing which I'm trying to keep in mind, at least the parts I remember. But I probably need a refresher on it :) |
divagant-martian
approved these changes
May 28, 2024
Co-authored-by: Divma <[email protected]>
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
This updates the top-level docs for iroh-net to be a general
overview of what the crate provides, since this is effectively the
docs.rs landing page.
Breaking Changes
None
Notes & open questions
This should include an examples section as well. However... the API
is a bit pants and does not lend itself to a nice echo example here.
Let's tackle this separately.
This does not change the README, that is already fairly decent and
seems compatible with this content.
Change checklist
[ ] Tests if relevant.[ ] All breaking changes documented.