feat(docs): generate docs for cli and automate w/ #1253
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CI. on every push to develop, a GH action will run the generator script and open a PR against develop branch if there is a diff.
fadeev
previously approved these changes
Jun 16, 2021
Yes I absolutely agree with this. Go relayer is more useful for debugging but this is not an advantage if we don't make further development with the current one |
lumtis
previously approved these changes
Jun 17, 2021
Co-authored-by: Lucas Bertrand <lucas.bertrand.22@gmail.com>
Jchicode
pushed a commit
to Jchicode/cli
that referenced
this pull request
Aug 9, 2023
* feat(docs): generate docs for cli and automate w/ CI. on every push to develop, a GH action will run the generator script and open a PR against develop branch if there is a diff. * docs * Update starport/internal/tools/gen-cli-docs/main.go Co-authored-by: Lucas Bertrand <lucas.bertrand.22@gmail.com> Co-authored-by: Lucas Bertrand <lucas.bertrand.22@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CI.
on every push to develop, a GH action will run the generator script and
open a PR against develop branch if there is a diff.
I haven't created a seperate ToC where we list all commands as a tree because something similar already exists as a menu in the right sidebar which is produced by the web app dynamically.
Since we attach
rlycommand from the legacy go-relayer to Starport cmd, it's also added to the docs. If you think that's too much we can avoid creating docs for it or we can remove therlycommand fromstarport relayer.Let me know if you want to change anything like menu name, order, description etc. for this new doc page.