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

proposal: remove commands.md #469

Closed
alexanderbez opened this issue Mar 25, 2021 · 1 comment · Fixed by #475
Closed

proposal: remove commands.md #469

alexanderbez opened this issue Mar 25, 2021 · 1 comment · Fixed by #475
Assignees
Labels
T: Proposal TYPE: Proposal

Comments

@alexanderbez
Copy link
Contributor

I propose we remove https://github.com/cosmos/relayer/blob/master/docs/commands.md.

I spent a bit of time cleaning up the CLI command UX only to realize I have to groom through this large doc and update it. I believe we should remove this doc for two primary reasons:

  1. Continuous burden of maintenance and keeping the doc in sync with the actual CLI.
  2. The CLI itself should and does act as its own source of documentation.
    2a. Anything that may cause confusion or that needs more explanation should be outlined and documented elsewhere, e.g. Readme, FAQ, Wiki, etc...

Would like to get an approval from @colin-axner, @jackzampolin or @AdityaSripal

@alexanderbez alexanderbez added the T: Proposal TYPE: Proposal label Mar 25, 2021
@alexanderbez alexanderbez self-assigned this Mar 25, 2021
@colin-axner
Copy link
Contributor

ACK - I completely agree. It is just extra maintenance debt

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

Successfully merging a pull request may close this issue.

2 participants