Rustdocs for every version of HotStuff-rs that has been published to crates.io is already automatically available in docs.rs. However, because of limitations in docs.rs, these rustdocs only include documentation for private items.
This is undesirable, since HotStuff-rs documents a lot of essential concepts in the module-level docs of private modules--as well as on top of private items--for the sake of locality with the most relevant code. For example, even though "quorums" are an essential concept in HotStuff-rs, they are only fully described in the itemdocs for Certificate::quorum, which does not appear in docs.rs for HotStuff-rs v0.4 because Certificate is a pub(crate) trait.
This repository provides a convenient way to read the documentation for these private items and modules by generating rustdocs using the --document-private-items option, and publishing them on a public GitHub Pages website.
- branch/
- branch_name_1 (sanitized to be url-safe)
- contents of target/doc/ of "hotstuff_rs" repo checked out to branch_name_1
- etc...
- tag/
- tag_name_1 (sanitized to be url-safe)
- contents of target/doc/ of "hotstuff_rs" repo checked out to tag_name_1
- etc...
The deploy_docs.yml automatically ensures that the docs on this repository is up-to-date with the source code in parallelchain-io/hotstuff_rs.