Replace hookdoc with WP Hooks Documentor

[iamdharmesh]

Description of the Change

PR replace the existing hookdoc package with the WP Hooks Documentor package which is used for generate developer docs. The new package is uses the docusaurus and provide good flexibility on extending docs site.

Note

The Distributor's yellow color is a bit light for the light theme, so I used a slightly darker shade here. Please let me know if we should use a different color instead. Dark mode looks fine, no changes there.

Closes #1336

How to test the Change

1. Run npm i && npm run build:docs
2. Run cd ./docs-build && npm run serve
3. Visit http://localhost:3000/distributor to check generated doc site.

Changelog Entry

Developer - Replaced hookdoc with WP Hooks Documentor

Credits

Props @jeffpaul, @iamdharmesh

Checklist:

• I agree to follow this project's Code of Conduct.
• I have updated the documentation accordingly.
• I have added Critical Flows, Test Cases, and/or End-to-End Tests to cover my change.
• All new and existing tests pass.

[dkotter]

Code looks good here but I agree on the note around the yellow color.

This is very hard to read and I expect does not pass color contrast accessibility. This color works on the Distributor site because we only use it when the background is black. But on a white background, you can barely read the yellow text.

There's a few approaches I could see here:

1. Only have the dark mode theme and don't allow switching to light mode. That matches how our plugin site looks so may be fine
2. Anywhere we have yellow text, ensure the background is dark. This would be similar to always forcing dark mode but would still retain some lighter elements
3. (easiest option probably) Don't use that yellow color for text if the text is on a light background. Not sure what color to replace it with though, could just always use black but not as fun visually then

Open to other suggestions / opinions on this though, cc @jeffpaul

[iamdharmesh]

I deployed this on my fork repo here: https://iamdharmesh.github.io/distributor/ to get feedback on color in light mode.

cc: @jeffpaul

[dkotter]

@iamdharmesh One other thing we'll need to take care of here that I just realized we missed in ClassifAI is to update any existing links within our code that points to the old documentation site. I know there's some in the changelog and looks like some in the documentation itself

[peterwilsoncc]

Thanks for working on this, in addition to the accessibility issues I've got a couple of notes:

• defined in lines in the source section, eg on this page:
  • would it be possible to link to the permalink rather than trunk, eg https://github.com/10up/distributor/blob/[commit-hash]/includes/utils.php#L318
  • would it be possible to highlight the start of the docblock through to the apply_filters|do_actions, eg https://github.com/10up/distributor/blob/4831cdcc01ac23f32f28b5bb51c683a610d7c34c/includes/utils.php#L311-L322

[jeffpaul]

@peterwilsoncc will probably need your help finishing off the changes needed here before getting a final review from @dkotter

[peterwilsoncc]

@jeffpaul @dkotter What do you think of using the default colour scheme for the initial merge and we can then tidy it up to look more like distributorplugin.com once the code goes in?

[dkotter]

@jeffpaul @dkotter What do you think of using the default colour scheme for the initial merge and we can then tidy it up to look more like distributorplugin.com once the code goes in?

Fine by me, I think this is way better than what we have now so would be nice to get this in

[peterwilsoncc]

I've pushed a couple of commits to restore the default styles and make some slight colour tweaks in order to meet WCAG AA contrast minimums.

[jeffpaul]

@peterwilsoncc once we land this update here it looks like we'll also want to over in https://github.com/10up/safe-redirect-manager and https://github.com/10up/simple-google-news-sitemap