woocommerce / woocommerce/code-reference
Add a hook generator
Nobody has claimed this yet.
- Dominant language
- Twig
- Stars
- 17
- Forks
- 12
- Avg merge
- 3h 58m
- Merged PRs (30d)
- 3
Description
Currently we are using an old script that doesn't capture all files from our source code.
You can find the current script in https://github.com/woocommerce/code-reference/blob/trunk/generate-hook-docs.php
We could take this opportunity to create a documentation for hooks generating several pages for individual files and types like actions and filters.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading generate-hook-docs.php to understand how the current script discovers source files and generates hook documentation. Define the scope for capturing all source files and producing separate pages for individual files, actions, and filters; done means the generator creates the intended documentation pages from the source code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100