Documentation for Public Methods

[aphelionz]

Rust documentation can be improved overally, but mainly in two places:

1. Instantiating and setting up an IPFS node
2. All of the methods in the Ipfs struct, i.e. the main functions that a Rust programmer will use to interact with an IPFS node

To find the remaining places, uncomment src/lib.rs #![warn(missing_docs)].

When developing docs, the docs are catered towards https://docs.rs/ipfs distribution. This basically means generating the docs with the latest nightly (or what docs.rs is using), then running cargo +nightly doc --workspace --no-deps --open. We are still a bit undecided of the #![allow(private_intra_doc_links)] but possibly leaning towards allowing it when it becomes possible with stable rust. So don't worry about cargo +nightly doc warning about private_intra_doc_links.

[koivunej]

After #392 we are now about 60% documented according to docs.rs.

If you are interested in helping out, probably easiest way to find anything to work on is to either:

• clone, commend out src/lib.rs:18, run cargo check
  • this will produce around 180 errors but works well with rust-analyzer and an IDE
• browse docs.rs/ipfs

[koivunej]

Updated the issue description with the nightly/docs.rs hints, lint recommendations.