search

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

Improve documentation readability #39

Closed valefar-on-discord closed 4 weeks ago

valefar-on-discord commented 2 months ago

Forward from:

The README is not exactly ideal and can be greatly improved. I feel a separate website for documentation might be warranted but perhaps a reorganization of the README could suffice.

valefar-on-discord commented 1 month ago

I've been playing around adding this to ethstaker.cc as a separate page similar to https://ethstaker.cc/staking-software/wagyu

Here is an very rough draft of it:

Screenshot 2024-05-27 at 8 49 38 AM

Does this seem acceptable or do we think there is a superior approach?

I'd add installation instructions as well and I'm thinking about having a OS selection at the start that will modify the documentation

remyroy commented 1 month ago

I'd love to have a separate website for documentation. There are a bunch or great tools for this: readthedocs and mdBook are two of the great ones that can integrate with the repository.

remyroy commented 1 month ago

I believe we could also host this for free on Github pages and have a workflow generate it automatically. See https://stackoverflow.com/questions/62683329/how-to-self-host-read-the-docs-using-github-pages for instance.

remyroy commented 1 month ago

https://docusaurus.io/ could be another tool for this

valefar-on-discord commented 1 month ago

Played around with mdBook and this was the result: https://valefar-on-discord.github.io/ethstaker-deposit-cli/index.html

remyroy commented 1 month ago

I really like the style and result of mdBook. I might have slight preference for mdBook over readthedocs but I don't have a good informed opinion about the underlying tech or features.