It seems that the landing page of the documentation build with cargo doc and the contents of the README.md are very close to each other, or almost identical.
I would suggest to focus your efforts and to provide the some of the information only in the technical documentation build by cargo doc. My suggestion is to remove the following subsections from the README.md file:
Latest README version
Useful tips for features
Module Structure
Documentation
Examples
Release Info (maybe)
Contributing Guide
LICENSE
TODO
I furthermore suggest to shorten the list of bullet points to contain more than one variant per category. i.e. changes like so:
# PREVIOUS
- Probability Distributions
- Bernoulli
- Uniform
- ...
# NEW
- Probability Distributions (Bernoulli, Uniform, ...)
openjournals/joss-reviews#10366 (comment)
It seems that the landing page of the documentation build with
cargo docand the contents of theREADME.mdare very close to each other, or almost identical.I would suggest to focus your efforts and to provide the some of the information only in the technical documentation build by
cargo doc. My suggestion is to remove the following subsections from theREADME.mdfile:I furthermore suggest to shorten the list of bullet points to contain more than one variant per category. i.e. changes like so:
openjournals/joss-reviews#10366 (comment)