[wp-meta] [Making WordPress.org] #4376: Centralized API handbook
Making WordPress.org
noreply at wordpress.org
Wed May 1 03:55:16 UTC 2019
#4376: Centralized API handbook
---------------------------+---------------------
Reporter: casiepa | Owner: (none)
Type: enhancement | Status: new
Priority: normal | Milestone:
Component: Developer Hub | Resolution:
Keywords: 2nd-opinion |
---------------------------+---------------------
Comment (by atachibana):
I am 100% agree to "APIs Handbook" that will gather WordPress.org APIs and
Core APIs listed in right side of
[https://developer.wordpress.org/reference/]. Currently, Plugins Handbook
covers some of them but many API entry pages remain in Codex. If we can
provide them in DevHub, developer must feel convenient.
I have some proposal based on the last docs team meeting with @Kenshino
and @milana_cap
**Page Structure**
Each API page (except REST API, which has independent handbook) should
have Overview, Description, Usage examples and list of functions.
**Table of Contents**
- Dashboard widgets
- Database
- HTTP API
- Filesystem
- Metadata
- Options
- Plugins
- Quicktags
- REST API
- Rewrite
- Settings
- Shortcode
- Theme Modification
- Transients
- XML-RPC
-
- WordPress.org
- Central (for WordCamp)
- WordPress.tv
- Translation
**Creation Workflow
1. (meta) Create page structure under the https://developer.wordpress.org
2. (docs) Migrate Codex Pages or Copy from Themes/Plugins Handbook to
there
3. (core) Review and Update by the Core reps. Some of contents might be
out of date.
4. (docs) Release
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/4376#comment:7>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list