Docs for Rust devs

[naveen-ravi2810]

Creating docs for the rust developers in specific to up-rust

addresses 176

[sophokles73]

@naveen-ravi2810 I appreciate the effort of trying to improve the documentation 👍
What we are in need of is more practical developer guidance by means of examples etc which supports developers in using the API. The kind of documentation that you have put into this draft so far seems to be more focused on generic concepts in Rust and Git. FMPOV users will either already know that or will not have a hard time figuring it out based on existing Rust and Git documentation (available online).

[naveen-ravi2810]

@naveen-ravi2810 I appreciate the effort of trying to improve the documentation 👍 What we are in need of is more practical developer guidance by means of examples etc which supports developers in using the API. The kind of documentation that you have put into this draft so far seems to be more focused on generic concepts in Rust and Git. FMPOV users will either already know that or will not have a hard time figuring it out based on existing Rust and Git documentation (available online).

Understood @sophokles73
I will make the documentation for the API's examples

[PLeVasseur]

Hey @sophokles73 -- to make sure we set @naveen-ravi2810 up the right way, which format would the documentation be the most helpful do you think?

I can think of a few:

1. flesh out more doc comments with elaborated examples
2. add examples to an examples/ folder which shows how to use up-rust
3. markdown documentation in the repo
4. MDBook which documents usage which is eventually deployed to e.g. GitHub Pages, maybe even a subdomain on uprotocol.org

My 2c: start with 3. with plans to eventually turn into 4.

What do you think?