adamziel / playground-docs-workflow

Experimenting with maintaining WordPress docs using WordPress Playground
https://adamziel.github.io/playground-docs-workflow/
11 stars 2 forks source link

WordPress Playground for Documenters

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


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:

https://github.com/adamziel/playground-docs-workflow/assets/205419/5d06d8b8-cd9f-4cec-a8c6-e73d66e82159

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