Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Action and Filter Reference Documents to DevHub #370

Open
jonathanbossenger opened this issue Jun 13, 2022 · 6 comments
Open

Add Action and Filter Reference Documents to DevHub #370

jonathanbossenger opened this issue Jun 13, 2022 · 6 comments
Assignees
Labels
APIs Issues for Common APIs Handbook developer documentation (DevHub) Improvements or additions to developer documentation migration from Codex Migrating content from Codex to HelpHub/DevHub. new document Requests for new page/article. [Status] In progress Issue is in progress

Comments

@jonathanbossenger
Copy link

What is the new page you are requesting?

Two new pages based on the Codex pages on the Action Reference list and Filter Reference list

How will this new page help you?

These two pages are valuable reference documents for WordPress developers, as it allows a developer to both determine the correct hook to use, based on when the hook is executed. It also provides a great high-level overview of what each hook does and then links to each specific hook's DevHub doc.

Additional notes

It has been suggested that both pages should be added to the Common APIs handbook.

Once these pages have been added, they can be updated with any newly added hooks, as well as fixing the broken links that currently exist on each page.

@jonathanbossenger jonathanbossenger added the new document Requests for new page/article. label Jun 13, 2022
@jonathanbossenger
Copy link
Author

I'd appreciate it if someone can a) assign me to this ticket, and b) help me with getting access to DevHub, to be able to add these pages, and get them updated.

@zzap zzap added developer documentation (DevHub) Improvements or additions to developer documentation APIs Issues for Common APIs Handbook labels Jun 14, 2022
@jonathanbossenger
Copy link
Author

Shoot, I need to finish this up...

@jonathanbossenger
Copy link
Author

Hi folks.

In light of the recent changes to the Codex, I have submitted the two drafts (Action Reference and Filter Reference) to be published to the common APIs section of the handbook.

I also created a parent page (Hooks) for these two pages, so that once the references are published, we can nest the two reference pages under Hooks.

At the same time, we should probably update the links at the bottom of the Hooks page in the Plugin developer handbook.

@jonathanbossenger jonathanbossenger self-assigned this Feb 22, 2024
@github-actions github-actions bot added [Status] In progress Issue is in progress and removed [Status] To do Issue marked as Todo labels Feb 22, 2024
@jonathanbossenger
Copy link
Author

Noting that most of the links on the new pages are broken, probably because the codex pages don't exist anymore.

@flexseth
Copy link
Collaborator

Related work is going on here @jonathanbossenger

Working on it. It's a lot of links :)

Tagging for tracking/to be able to submit to review/close when finalized.

@flexseth
Copy link
Collaborator

Noting that most of the links on the new pages are broken, probably because the codex pages don't exist anymore.

This is correct. To a certain, perhaps unfortunate degree.

That said, we can link directly to the Inline Documentation of the code which should help advanced users. Or if possible, update the DocBlocks to reflect necessary info to pull in the reference info.

I'm not 100% sure exactly what the best approach is yet for this, but should figure it out while working on the various broken links in the Common APIs Handbook post.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIs Issues for Common APIs Handbook developer documentation (DevHub) Improvements or additions to developer documentation migration from Codex Migrating content from Codex to HelpHub/DevHub. new document Requests for new page/article. [Status] In progress Issue is in progress
Projects
None yet
Development

No branches or pull requests

4 participants