New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize documentation and make it more uniform #70

Open

remyroy opened this issue Jun 18, 2024 · 0 comments

Assignees

Labels

documentation help wanted

Member

remyroy commented Jun 18, 2024

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/ .

remyroy added the documentation label

yorickdowne added the help wanted label

remyroy mentioned this issue

Document how to publish the various messages that are generated #148

Closed

remyroy assigned nixorokish

nixorokish mentioned this issue

Moved majority of README info into docs #172

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment