Skip to content
This repository was archived by the owner on Apr 13, 2020. It is now read-only.

generate doc for command#454

Merged
dennisseah merged 4 commits intomasterfrom
genDoc
Mar 26, 2020
Merged

generate doc for command#454
dennisseah merged 4 commits intomasterfrom
genDoc

Conversation

@dennisseah
Copy link
Collaborator

anyone has any ideas on how to generate doc for commands automatically? thanks

@andrebriggs
Copy link
Collaborator

andrebriggs commented Mar 26, 2020

@dennisseah you mean when a <command>.json file is updated we should regenerate the documentation has a pre-commit step?

@dennisseah
Copy link
Collaborator Author

@dennisseah you mean when a <command>.json file is updated we should regenerate the documentation has a pre-commit step?

yes, how to do this in pre-commit hook?

@evanlouie
Copy link
Collaborator

we use husky for pre-commit hooks. You can add to the husky.hooks.pre-commit script it package.json

@dennisseah
Copy link
Collaborator Author

we use husky for pre-commit hooks. You can add to the husky.hooks.pre-commit script it package.json

I do not know how to do this. Will reach out to you. thanks

@andrebriggs andrebriggs requested a review from jmspring March 26, 2020 19:16
Copy link
Contributor

@jmspring jmspring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content edits will be handled in a separate issue, otherwise LGTM.

@dennisseah
Copy link
Collaborator Author

Content edits will be handled in a separate issue, otherwise LGTM.

@jmspring these are generated content from command json files, people forgot to generate them in previous PRs. And this will never happen again because @evanlouie showed me how to add git pre-commit hook. thanks

@dennisseah dennisseah merged commit 8a6a84d into master Mar 26, 2020
@dennisseah dennisseah deleted the genDoc branch April 6, 2020 22:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants