-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DHT module docs #51
DHT module docs #51
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that's good. I think api crate and main crate are equally valid places for this. Slight preference for main crate.
I think I prefer the |
sure! |
bd1021a
to
478a77e
Compare
I'll continue this after #59 |
478a77e
to
46e15d1
Compare
ec38a0a
to
05a7d49
Compare
Suggestion: #66 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some different options for the build.rs and svgs. All the text and changes look good to me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉
0e7b8b2
to
50d12a8
Compare
This PR now does three things. Some minor code cleanup and documentation consistency for existing code. Then I've also added some top level crate docs with diagrams and started a glossary. Initially this PR just had the glossary.
It might be too early for this, just thinking about where to put the glossary of terms that @zippy asked for. I think it's a good idea, we've already got a bunch of terms we use that wouldn't be clear to anybody who didn't work on Kitsune1 :)
I'm thinking the API is a decent place. Everything will have a trail back to the API, it's the starting point for anybody integrating with Kitsune2.
A better place might be the main module (the equivalent of kitsune_p2p) because that's where we'll have the maximum number of dependencies available to use for type references.
Doing a glossary like this, we get nice easy to reference links to terms -> file:////kitsune2/target/doc/kitsune2_api/doc/glossary/index.html#time-slice