open-i18n/rust-unic

Set up homepage+tutorial+api-doc generation

behnam opened this issue · 1 comments

As we are expanding UNIC components and add more functionality for string processing and locale data, we need to add tutorial-like documentation on what is where and how to use the features.

Like many other Rust community projects, we can use mdBook for this, and make the landing page of the book to be our homepage, with links to project repo and docs.rs API docs.

Optionally, we can have a local copy of the API docs. This can be useful for checking API docs on master before publishing as a package.

What do you think?

CAD97 commented

Also a possibility: doxidize (aka rustdoc2)