[wp-meta] [Making WordPress.org] #2345: Create an automated workflow for the WP REST API reference.
Making WordPress.org
noreply at wordpress.org
Mon Dec 26 17:12:02 UTC 2016
#2345: Create an automated workflow for the WP REST API reference.
---------------------------+-----------------
Reporter: ChopinBach | Owner:
Type: task | Status: new
Priority: normal | Milestone:
Component: Developer Hub | Keywords:
---------------------------+-----------------
The reference located in the handbook is currently some copy pasta magic.
Moving into the future, it will be important to keep the reference up to
date and accurate; automation is essential. It will be equally important
to look at different versions of the API, as it has been changing quite a
bit. There are four primary goals to this plugin:
(1) Produce HTML
(2) Provide a way to add extra human-readable documentation for each field
(3) Handle versioning correctly
(4) Handle any site
To best accommodate these four needs, a JavaScript based browser
application will most likely work best. By taking this approach external
authentication is not necessary. It will also provide a neat little plugin
that other WordPress installations can use to manage their API reference.
I should have an MVP running by Friday, and would love other people's
opinions/help. Development will happen here https://github.com/BE-
Webdesign/wp-rest-api-reference.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/2345>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list