Add examples to documentation

[NullSense]

Examples need to be added to the public items as per Rust documentation guidelines.

[Rajratnpranesh]

I want to contribute to the repo. Please discuss the details of the issue. Thanks

[NullSense]

@Rajratnpranesh Thanks for taking up this issue, basically examples of how to use public API functions need to be added to the documentation. The Rust documentation guidelines are a good place to start, you might also want to take a look at other crates, e.g. the http crate request.rs docs.

[Rajratnpranesh]

@NullSense Can it be any API function that can be used as an example?

[NullSense]

Yes, there's only a few public ones, feel free to document all of them if you like.

[Rajratnpranesh]

@NullSense I made a pull request to add API_Documentation.md. Please have a look. I talked about calling GitHub Public API.

[NullSense]

@Rajratnpranesh Sorry if I didn't make the issue clear, but by documentation of the public facing API, I meant documentation for the Linda project itself not GitHub.