-
Notifications
You must be signed in to change notification settings - Fork 31
Add CLI documentation generator #2562
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
base: main
Are you sure you want to change the base?
Conversation
|
The approach to auto-generating the CLI docs is really clever. Having said that, I think what's implemented in this PR doesn't totally reflect the requirements in the ticket created by @aowen-uwmad. My understanding was that the goal is to have the docs live on the documentation website directly. The current implementation seems to require users to run a manual command to generate and view them. Maybe it is just an intermediate PR? |
|
@patrickbrophy These errors aren't tied to anything I can help with. My guess from looking through things is that when Haoming set this up he held an assumption of run order so things didn't break. I see some placeholder magic in the Maybe add this to the |
263cb37 to
95a2891
Compare
546c437 to
2bc8aa3
Compare
|
@patrickbrophy , I know there are some "hidden" commands that dev team doesn't necessarily want users to know about.. |
|
Yes the generator takes that into account. A command is "hidden" when the |
d5dbca4 to
f2f83c2
Compare
|
The screenshot of the updated navigation bar looks good to me. |
aowen-uwmad
left a comment
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.
I did a local preview and explored the commands reference pages; I think it looks good.
I can't speak to the Go or CI/CD pieces, though, so someone else should review that to approve this.
|
This PR is blocked by #1765. Will need to be refactored to address the changes in there. |


This PR addresses issue #2472. This PR allows for documentation to be automatically generated using the
go generatecommand. A minor implementation note, I had to put the generation code in thecmdpackage because of how Go handles accessing exported variable inside themainpackage.