[wp-meta] [Making WordPress.org] #7642: Developer documentation: wrong source is used as a reference
Making WordPress.org
noreply at wordpress.org
Fri May 17 01:00:39 UTC 2024
#7642: Developer documentation: wrong source is used as a reference
-----------------------------+---------------------
Reporter: markhowellsmead | Owner: (none)
Type: feature request | Status: new
Priority: normal | Milestone:
Component: Handbooks | Resolution:
Keywords: |
-----------------------------+---------------------
Changes (by dd32):
* component: General => Handbooks
Old description:
> 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''.
New description:
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''.
--
Comment:
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
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/7642#comment:2>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list