[CI] Generate `README`s from crate docs

Open ggwpez opened this issue 1 year ago • 2 comments

Most of our crates have no/outdated/insufficient READMEs on crates-io. Now instead of trying to replicate the crate docs in the README and rust doc, we can used cargo-readme to generate a README file from the crate package doc.

I think we should set up a CI check that verifies that all README files that exist are either auto generated or whitelisted as "manually maintained" in some config file. The second option would only be a intermediate™ solution.

Jan 15 '24 11:01 ggwpez

Related or duplicate of #1260 ?

Jan 16 '24 21:01 nuke-web3

Related or duplicate of #1260 ?

Not quite, we should still do that.

Feb 05 '24 14:02 ggwpez