Rustdocs

[clehner]

Rust docs

https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html

The crate front-pages and all public API should be documented. Examples should be added.

If things are found in the public API that should not be public, they should be marked as pending removal from the public API.

A development build of the docs is here: https://rust.didkit.dev/ssi/

To build the docs locally:

cargo doc --no-deps

To build with more features enabled:

cargo doc --no-deps --features secp256r1,secp256k1,ripemd-160,http-did

Then open the file target/doc/ssi/index.html in a web browser.

Documentation progress

This checklist was originally in #311.

• [ ] Fix build failure: #310
• [ ] Document public API
  • [ ] ssi crate front-page
  • [ ] ssi modules
    • [x] bbs, blakesig, caip2, caip10, der, did, did_resolve, error, hash: #311
    • [ ] jsonld
    • [ ] jwk
    • [ ] jws
    • [ ] jwt
    • [ ] ldp
    • [ ] one_or_many
    • [ ] rdf
    • [ ] revocation
    • [ ] soltx
    • [ ] ssh
    • [ ] tzkey
    • [ ] urdna2015
    • [ ] vc
    • [ ] zcap
  • [ ] DID Method crates
    • [ ] did-ethr
    • [ ] did-key (did-method-key)
    • [ ] did-onion
    • [ ] did-pkh
    • [ ] did-sol
    • [ ] did-tezos (did-tz)
      • [ ] Input metadata options (-i option for didkit did-resolve) - as mentioned in https://github.com/spruceid/ssi/pull/311#issuecomment-942336068
    • [ ] did-web
    • [ ] did-webkey
  • [ ] ssi-contexts crate
• [ ] Check docs coverage during CI