IronCoreLabs / ironoxide

Rust SDK for IronCore Privacy Platform
https://docs.rs/ironoxide
GNU Affero General Public License v3.0
10 stars 3 forks source link

Improve module documentation #144

Closed giarc3 closed 4 years ago

giarc3 commented 4 years ago

Each module (group, user, etc.) should be updated with improved function documentation, examples, links to relevant structs, and guides. We should follow Rust documentation guidelines as much as possible (like short description followed by full description, doctests, markdown sections headers, consistent voice, etc.). We should also pay extra attention to the ironoxide docs site landing page and make sure that the module and information about it guides a reader to important quickstart steps.