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

Add Documentation to Github Page #63

Closed valefar-on-discord closed 4 weeks ago

valefar-on-discord commented 1 month ago

Utilizing mdBook to generate documentation on how to setup and run the CLI.

This is maintained through git actions where when main is updated, it will push the changes to a gh-pages branch that will then deploy to the repo's github page.

Setting up the github page settings will be required once this is considered good to go.

Any feedback on the content of the documentation is welcome and the current version can be viewed here

Fixes #39

remyroy commented 4 weeks ago

Once you are done with the changes, can you rebuild the mdBook and have it published in the same location or somewhere else for me to see? I'm checking again on https://valefar-on-discord.github.io/ethstaker-deposit-cli/ and it's the original PR without your changes.

valefar-on-discord commented 4 weeks ago

I believe I updated everything. There is a lot going on here so go easy on me if I missed something.

I did update the current version: https://valefar-on-discord.github.io/ethstaker-deposit-cli/

Edit: I've noticed a styling discrepancy between local and live involving the warning messaging. I'll need to investigate this.

valefar-on-discord commented 4 weeks ago

Noticed a version difference with 0.4.10(action) and 0.4.40(running locally) and then noticed this commit: https://github.com/rust-lang/mdBook/commit/65dae11e470450bddbe8451e7c3b5d27ca01f30a

Updating from 0.4.10 to 0.4.40 fixed the styling issue and docs look aligned now.