Skip to content
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.

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 · 1 comment
Open

Standardize documentation and make it more uniform #70

remyroy opened this issue Jun 18, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@remyroy
Copy link
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:

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
Copy link
Member Author

remyroy commented Oct 11, 2024

All that is left here would be to make the documentation in our source code and the one for the click CLI help the same as the one we can find in the documentation on https://deposit-cli.ethstaker.cc/ where it applies and taking the work, expressions and phrasing used on https://deposit-cli.ethstaker.cc/ as the reference point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants