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.
Supersedes #65.
Motivation
We're having lots of people who want to use Raft, but they don't know how! @queenypingcap did a great job assembling some examples and writing around how to use the crate, however it made the README very long.
This PR moves that content (with minor refactoring) into the Rust API docs generated by https://docs.rs/raft/ and
cargo doc
.Further Work
There should be a follow up in the future that makes all examples fully tested, but for now this is a big enough step forward. :)