Making WordPress.org

Opened 5 weeks ago

Last modified 5 weeks ago

#7642 new feature request

Developer documentation: wrong source is used as a reference

Reported by: markhowellsmead's profile markhowellsmead Owned by:
Milestone: Priority: normal
Component: Handbooks Keywords:
Cc:

Description (last modified by dd32)

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 Slack @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 the current version in WordPress Core.

What is your proposed solution?

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

Additional

Discussions in Slack indicate that it might make sense to base the documentation on a specific branch, so that a user can switch between documentation of previous versions. For example, wp/6.5.

Change History (2)

#1 @fabiankaegy
5 weeks ago

Yeah, as mentioned, I believe the main action item right now is to point the docs to pull from the wp/6.5 branch instead of trunk and then always update it alongside a major release.

#2 @dd32
5 weeks ago

  • Component changed from General to Handbooks
  • Description modified (diff)

We have previously imported from the stable branch, but [9963] reverted back to the trunk branch.

See #5266 & #5020 for the limited history I have.

I suspect that reverting to using the stable version would cause the same confusion again, without extra effort being put into creating versioned handbooks.

If the Editor team would like to confirm the direction, a PR can be opened against https://github.com/WordPress/wporg-developer/blob/1c40953d68c3554499859d61bbbb859870fb5ffa/source/wp-content/themes/wporg-developer-2023/inc/import-block-editor.php#L8

Note: See TracTickets for help on using tickets.