Generate Hook Docs with a GitHub Action

[adamsilverstein]

Description of the Change

Addresses #387.

• Add wp-hookdoc a package designed to parse WordPress hooks using JSDON
• Add the @hook notation wp-hookdoc requires across the plugin for all instances of apply_filter and do_action. (side note: that was tedious, open an upstream issue to remove that requirement).
• Noted a few hooks that are not documented with @todo notes, cleaned up a few arrays definitions that weren't getting parsed correctly.
• Add an npm command to build the docs: npm run build:docs
• Add a GitHub Action yaml file that builds the docs for every commit to develop.
• Action is now set to deploy to GH Pages, I can add an auth token once the PR is merged.

Alternate Designs

Considered phpdoc-parser https://github.com/WordPress/phpdoc-parser which is used in WordPress core. This project seems more suited for GitHub Actions and our needs.

Benefits

Builds hook docs automatically with an action on each deploy.

Verification Process

• run npm install && npm run build:docs.
• open hook_docs/index.html in a browser.

Checklist:

• I have read the CONTRIBUTING document.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my change.
• All new and existing tests passed.

Applicable Issues

[jeffpaul]

Thoughts on adding a link to the resulting GitHub Page to distributorplugin.com?

[adamsilverstein]

Thoughts on adding a link to the resulting GitHub Page to distributorplugin.com?

yes, we can do that in a follow up PR once this is merged and we are happy with how the GH pages look.