-
Notifications
You must be signed in to change notification settings - Fork 36
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
Auto generate cli docs #71
Merged
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
feedmeapples
approved these changes
Feb 2, 2023
flossypurse
approved these changes
Feb 2, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, looking good to me.
As long as @feedmeapples is good with it!
Changed links for linkmagic |
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.
What was changed
A program that extracts information about the commands and converts it to Markdown files. This would then be exported to the documentation team to use as source docs for their purposes.
Why?
Saves time on figuring out the intricacies of each command.
Keeps information updated as the main branch changes.
Checklist
Note: already created program that breaks down the markdown-converted application into separate files and directories, with basic Markdown formatting.
How was this tested:
I iterated each step of this program. I can confirm that it will work whether a /docs folder exists or not. It will continue to update what's present.
Any docs updates needed?
YES.
Docs team is going to download these files and use them to generate pages for the website.
Any feedback to the code, especially where additional information needs to be added for docs, would be greatly appreciated. I'm pretty new to Go and don't know how to advance from this point beyond creating more manual work in the docs repo.
UPDATE: program is nearly complete. Just needs additional text in UsageText and it will fully generate docs. And, also, linking up to docs repo.