Standardize documentation and make it more uniform - Githubissues

eth-educators / ethstaker-deposit-cli

Secure key generation for deposits

https://eth-educators.github.io/ethstaker-deposit-cli/

Creative Commons Zero v1.0 Universal

2 stars 2 forks source link

Standardize documentation and make it more uniform #70

Open remyroy opened 3 weeks ago

remyroy commented 3 weeks ago

We have documentation in various places that use different terms, vocabulary, objectives and carry different intentions. Here is a short list:

The README file: https://github.com/eth-educators/ethstaker-deposit-cli/blob/main/README.md
The click documentation when calling from the CLI (in the source code)
Source code comments
mdBook published on https://eth-educators.github.io/ethstaker-deposit-cli/ and sourced from https://github.com/eth-educators/ethstaker-deposit-cli/tree/main/docs

We should do a pass to standardize everything based on the latest efforts on the mdBook from https://eth-educators.github.io/ethstaker-deposit-cli/ .