WordPress Playground for Documenters

This is an attempt to create a buildless Documentation Contributor Workflow that uses WordPress Playground to:

• Fetch the latest version of the documentation from the repository.
• Edit documentation in a browser-based editor.
• Preview the changes in real-time.
• Submit the changes as a pull request.
• Provide a live preview of the documentation PR.

 
Browse the Documentation
 .

How to edit the documentation?

In WordPress Playground

Click here to try it:

 
Edit the Documentation
 .

It should load the doc pages from the html-pages directory and the media attachments from uploads. This video demonstrates it:

Documentation.Workflow.mp4

Locally

To start a local server with the documentation site, run:

bash start-server.sh

You'll need node.js and npm installed.

Once you're done editing the documentation, commit your changes as follows:

git add wp-content
git commit -a

And then submit a Pull Request to the repository.

How to edit the site theme?

Adjust the site as needed in the site editor and then use the preinstalled create-block-theme plugin to save the theme updates and propose them as a PR.

Remaining work

• Put preview links in the GitHub PRs