/playground-docs-workflow

Experimenting with maintaining WordPress docs using WordPress Playground

Primary LanguagePHP

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.

How to use it?

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

Copy everything from wp-content into your local WordPress install, edit the docs, commit the changes back to this repo.

wp-now workflow is on the way, but it isn't ready yet.

Remaining work

  • Render a static documentation site to serve on GitHub pages. Currently the doc pages can be edited and previewed in Playground, but they are not rendered as a static site yet.
  • Put preview links in the GitHub PRs