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

Developer documentation: wrong source is used as a reference #61657

Closed
markhowellsmead opened this issue May 14, 2024 · 6 comments
Closed

Developer documentation: wrong source is used as a reference #61657

markhowellsmead opened this issue May 14, 2024 · 6 comments
Labels
[Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.

Comments

@markhowellsmead
Copy link

I recommend that the developer documentation relate to the current version of WordPress Core. As it stands, the current version relates to the Gutenberg plugin, which is not always in use. (Confirmed by @t-hamano in @WordPress/outreach.)

What problem does this address?

Some of the documentation—e.g. https://developer.wordpress.org/block-editor/reference-guides/slotfills/plugin-document-setting-panel/—is for the code in the Gutenberg plugin, not in WordPress Core.

What is your proposed solution?

The documentation should refer to the current version of core, not of the plugin.

@markhowellsmead markhowellsmead added the [Type] Enhancement A suggestion for improvement. label May 14, 2024
@fabiankaegy
Copy link
Member

It would be great to have the documentation versioned similar to how https://docusaurus.io for example does it. Where you have the latest stable core version but are then also able to see any changes in the alpha channel (in this case that would be the Gutenberg Plugin)

@Mamaduka
Copy link
Member

Related #61651.

@juanmaguitar
Copy link
Contributor

juanmaguitar commented May 14, 2024

For reference, there's a current effort (see #61036) to integrate JavaScript functions into the Functions Reference system so they can be navigated and consulted just like PHP functions.

This implementation would enable some improvements for JS functions docs, like providing @since info from JSDocs comments for each JS function or allowing comments from users (in the same way docs for PHP functions do)

@youknowriad
Copy link
Contributor

Can we close this issue and open one in http://meta.trac.wordpress.org/

The solution is just to follow what Core does for the Function reference... Use the "wp/6.5" branch instead of "trunk" when building the handbook.

The downside is that small typos and things like that won't be "live" until wp 6.6 is released but we can probably accept that, it's similar for the php functions anyway.

@markhowellsmead
Copy link
Author

@youknowriad
Copy link
Contributor

Thanks :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

5 participants