Trying to make ironoxide more easily understood from the docs alone. This PR focuses on the document functions and things related to them.
I added examples for every DocumentOps function, which are compiled (but not run, because of async issues) when running cargo test, helping prove that they don't become out-of-date.
I need feedback on how the landing page of the docs site should flow. My current thought is that each section (Users, Groups, Documents), as well as a higher level (like Initialization) will provide a bare-bones example of the most important functions to get you up and running. A reader could start at the top and see how to initialize, create a user, create a group, and encrypt/decrypt a document right from that page. There will also be links to important functions for each section.
Trying to make ironoxide more easily understood from the docs alone. This PR focuses on the
documentfunctions and things related to them.I added examples for every
DocumentOpsfunction, which are compiled (but not run, because of async issues) when runningcargo test, helping prove that they don't become out-of-date.I need feedback on how the landing page of the docs site should flow. My current thought is that each section (Users, Groups, Documents), as well as a higher level (like Initialization) will provide a bare-bones example of the most important functions to get you up and running. A reader could start at the top and see how to initialize, create a user, create a group, and encrypt/decrypt a document right from that page. There will also be links to important functions for each section.