-
Notifications
You must be signed in to change notification settings - Fork 15
feat(docs): create command-reference binary for documentation generation #181
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
Conversation
|
Used by https://github.com/endorhq/docs/issues/20 to generate the command reference. |
|
Converting to draft as there are a couple of TS issues. |
|
@Angelmmiguel this binary should not be part of the "official release", is just a way for us to generate the documentation in an automated way (it has some hardcoded things, but we should make it completely generic, not right now). Not sure how to do the "this should not be part of the official release" bit. |
Angelmmiguel
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.
This method is pretty cool as it automates the docs generation. However, I prefer to keep a strict separation between source code (end users) and internal tools. My comments are all in that direction, but I really like this idea for generating our docs!
0028947 to
cebe483
Compare
d353490 to
d2baba5
Compare
Angelmmiguel
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.
LGTM! Added a minor comment, but approving in advance
This PR introduces a new documentation generation system for the Rover CLI by creating a dedicated
command-referencebinary that automatically generates markdown documentation from the CLI command definitions.The refactoring extracts the program creation logic into a reusable function that can be used both by the main CLI and documentation utilities, enabling automated documentation generation without runtime side effects.
Changes
command-reference.tsas a new binary for generating CLI documentationlib/program.tswithcreateProgram()functionexcludeRuntimeHooksoptionpackage.jsonto includecommand-referencebinary in the CLI packagetsdown.config.tsto build both entry pointstsdowncommandNotes
The new documentation generation system provides a foundation for maintaining up-to-date CLI reference documentation that stays synchronized with the actual command definitions. The modular approach ensures the documentation generator can introspect the command structure without triggering validation hooks that require a git repository context.