matrix-rust-sdk icon indicating copy to clipboard operation
matrix-rust-sdk copied to clipboard

doc: Re-organize docs and add bindings'

Open Hywan opened this issue 3 years ago • 4 comments

The new gh-pages now has the following hierarchy:

  • crates/ for the documentation of the Rust crates,
  • bindings/ for the documentation of the bindings:
    • matrix-sdk-crypto-nodejs for the Node.js bindings of the crypto crate.

There is no index.html files in directories, so Github will probably return 404 responses. Not sure it's a problem though.

Why Draft PR? Because it is incomplete. I must update all README.md to update the links to the documentations, but first, I wanted to validate the new namings with you.

Hywan avatar Jun 13 '22 09:06 Hywan

Codecov Report

Merging #754 (69a65fc) into main (87639a4) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #754   +/-   ##
=======================================
  Coverage   77.37%   77.37%           
=======================================
  Files          94       94           
  Lines       13735    13735           
=======================================
  Hits        10627    10627           
  Misses       3108     3108           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 87639a4...69a65fc. Read the comment docs.

codecov[bot] avatar Jun 13 '22 09:06 codecov[bot]

How about adding a minimal index.html with links to the new locations instead?

gnunicorn avatar Jun 29 '22 07:06 gnunicorn

How about adding a minimal index.html with links to the new locations instead?

How about adding a minimal index.html with links to the new locations instead?

I'm fine with that. Will do it.

Hywan avatar Jun 30 '22 12:06 Hywan

After some discussions, let's add the bindings/ directory inside the rustdoc output for our Rust crates. That way, we won't break existing links to crates.

Hywan avatar Jul 21 '22 12:07 Hywan

Closed by https://github.com/matrix-org/matrix-rust-sdk/pull/894.

Hywan avatar Aug 16 '22 08:08 Hywan