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

Improve cli help docs for dev purge and dev reset commands #147

Closed
steezeburger opened this issue Aug 6, 2024 · 0 comments · Fixed by #160
Closed

Improve cli help docs for dev purge and dev reset commands #147

steezeburger opened this issue Aug 6, 2024 · 0 comments · Fixed by #160
Assignees

Comments

@steezeburger
Copy link
Member

steezeburger commented Aug 6, 2024

I think we can rewrite the descriptions to be informative.

We should answer these questions:

  • what exactly does purge delete?
    • can probably just add to existing help, something like: "Delete all data for a given instance. This includes chain state, configuration, and the service binaries. ..."
  • what does "reset config files" mean exactly?
    • I think it means to reset the config files to their default values, but we can make this more clear in the help text.
    • something like: "Reset base config file to default values. ...:
  • what does it mean to "reset the networks config? exactly?
    • again, I think it means to reset the config files to their default values, since a user may have updated a value here
    • "Reset network config file to default values. ..."
  • what does it mean to "reset sequencer state"?
    • I think this one means to delete cometbft and sequencer data
    • something like: "Reset Sequencer chain state to initial state. ..."

┆Issue Number: ENG-695

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants