Skip to content

Commit 6e0878c

Browse files
authored
Merge pull request #47 from 10up/update/wp-hooks-documentor
Update hook documentation guide
2 parents 61ecac4 + 77fd9ae commit 6e0878c

3 files changed

Lines changed: 254 additions & 158 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ This action automates some common repository operations, such as validating PR d
6868
- **Welcome first-time contributors:** Greet first-time contributors with a warm welcome message on their first issue or PR to the project.
6969
- **Auto-comment on new Issues/PRs:** Automatically adds a comment to newly opened issues and PRs. This can be used to request users to provide as much context as possible or share links to your contributing guidelines, or anything else that suits your use case.
7070

71-
### [Publishing generated hook documentation to GitHub Pages](hookdocs-workflow.md)
71+
### [Publishing generated hook documentation to GitHub Pages](wp-hooks-documentor-workflow.md)
7272

73-
If you follow the [JSDoc](https://jsdoc.app/) standard for your custom WordPress actions and filters, you can use this workflow to generate documentation for your theme/plugin and publish them to GitHub Pages. For an example of the output, see the [Distributor hook docs](https://10up.github.io/distributor/). The [linting workflow](https://github.com/10up/maps-block-apple/blob/develop/.github/workflows/linting.yml) of Block for Apple Maps is a good example how to use this action in practice.
73+
You can use this workflow to automatically generate a documentation for your WordPress plugin hooks (actions and filters) using the [WP Hooks Documentor](https://github.com/10up/wp-hooks-documentor) and publish them to GitHub Pages. For an example of the output, see the [Distributor hook docs](https://10up.github.io/distributor/).
7474

7575
### Validating project dependency licensing
7676

hookdocs-workflow.md

Lines changed: 0 additions & 156 deletions
This file was deleted.

0 commit comments

Comments
 (0)