Closed Gankra closed 9 months ago
So strictly speaking they actually want to install oranda
and run oranda dev
(which uses mdbook as a library and patches several bugs so that it can unify the themes).
I'll think about where to put that info.
Pushed up many more docs.
So strictly speaking they actually want to install oranda and run oranda dev (which uses mdbook as a library and patches several bugs so that it can unify the themes).
Indeed. It just seems important to make sure to document that mdbook is the... institution? in use.
Note: Either in the main README.md, or a README for this particular folder, contributors should be advised on what an "mdbook" is (and prompted to
cargo install mdbook
and consultmdbook --help
) in the likely event they have never seen one. This will allow them to know how to build the documentation. It seems reasonable to assume they have access to the default Rust tooling but, although you would not know this by the frequency of the community use, mdbook is technically not such: it is a user's binary crate.