Add Documentation to Github Page #63
Conversation
There was a problem hiding this comment.
A few minor stuff came up. I know a bunch of things are not uniformed across the various places where we document this project (the click CLI help, the README, the code comments, this new documentation, etc) The work to make everything uniform could happen here or in another PR but that is something to keep in mind. Let me know what you think.
|
|
||
| - **Use this tool offline**: We highly recommend using this tool in an offline environment, preferably air-gapped, using a live USB such as [Tails](https://tails.net/install/download/index.en.html). | ||
|
|
||
| - **Avoid using passwords or mnemonics as command line arguments**: When executing any command, you will be prompted for the necessary arguments. This prevents the arguments from being stored in your command history which could create an attack vector. |
There was a problem hiding this comment.
I just noticed you mention avoiding some CLI arguments here related to security. Even if we mention it here, it should also be mentioned immedialy next to actual arguments in each command page (inline or maybe with an mdBook warning section)
each sensitive arg
|
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. |
|
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 |
|
Noticed a version difference with 0.4.10(action) and 0.4.40(running locally) Updating from 0.4.10 to 0.4.40 fixed the styling issue and docs look aligned now. |
Utilizing mdBook to generate documentation on how to setup and run the CLI.
This is maintained through git actions where when
mainis updated, it will push the changes to agh-pagesbranch 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