Add/hookdocs workflow #189
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
helen
suggested changes
Mar 4, 2020
.github/workflows/build-docs.yml
Outdated
| on: | ||
| push: | ||
| branches: | ||
| - develop |
There was a problem hiding this comment.
Let's change this to master so that the hook docs don't update until we actually are ready to release a new version
There was a problem hiding this comment.
@helen should we make a similar change to Distributor and ElasticPress?
Co-Authored-By: Helen Hou-Sandi <helen.y.hou@gmail.com>
helen
approved these changes
Mar 4, 2020
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.
Description of the Change
This PR introduces the files needed to generate hook docs and deploy them to GitHub Pages for ClassifAI, similar to what was created for Distributor.
Alternate Designs
n/a
Benefits
More fully communicates the extensibility of ClassifAI via a hook documentation site.
Possible Drawbacks
We may not have JSDoc-formatted docblocks for our hooks, in which case we'll want to ensure those get added as well so that the hookdoc site is as complete and accurate as possible.
Verification Process
Manually compared to set up for hookdoc generation on Distributor.
Checklist:
Applicable Issues
n/a, mea culpa.
Changelog Entry