feat(cmd): add docs generator for cli #59
Merged
Conversation
This file contains 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
ravisuhag
reviewed
Oct 18, 2022
|
|
||
| // GenerateMarkdownTree generate cobra cmd commands tree as markdown file | ||
| // rootOutputPath determines the folder where the markdown files are written | ||
| func GenerateMarkdownTree(rootOutputPath string, cmd *cobra.Command) error { |
There was a problem hiding this comment.
@mabdh do we want to generate a single markdown or multiple?
There was a problem hiding this comment.
I think multiple markdowns would be easier to navigate via sidebar, wdyt @ravisuhag ?
There was a problem hiding this comment.
this is how the markdown shown in Siren
There was a problem hiding this comment.
If we are showing it reference i think it better to show it single markdown. How about we make this as an option? Support both in salt.
There was a problem hiding this comment.
Yes fair enough, we could also do that.
mabdh
force-pushed
the
cobra-docs
branch
2 times, most recently
from
cfbe18d to
e4d6eb6
Compare
ravisuhag
reviewed
Oct 19, 2022
ravisuhag
reviewed
Oct 19, 2022
|
@mabdh lets add option to generate single markdown file as well? |
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.
No description provided.