WordPress Playground documentation

[flexseth]

What is the new page you are requesting?

Add info in the developer docs (DevHub) for using the WordPress Playground.

Existing documentation

https://wordpress.github.io/wordpress-playground/

• Add/improve this on DevHub?

How will this new page help us

The WordPress Playground is a great way to spin up environments for testing Proofs of Concept, plugins, etc.

The Playground creates a WP instance in the browser automagically. No web server, no PHP installation, just an environment in the browser that is easy to work with, extensible, easy to re-create and disposable.

The goal is to provide documentation for how to use the Playground... on the WP.org Plugin Repository authors can create a quick link to an instance to test a plugin with minimal effort via WP Playground, but it isn't truly clear the benefits of this feature or how to implement on wp.org/plugins

@adamziel - author of WP Playground is requesting docs, if we can create docs for the Playground it allows the feature author to work on support and hand over documentation to the docs team.

[github-actions]

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

[flexseth]

Relevant trac ticket: https://meta.trac.wordpress.org/ticket/7487

Relevant docs request from last year:

• WordPress Playground documentation #828

[adamziel]

Thank you for opening this issue @flexseth, it sounds amazing!

Here's one resource we now have on developer.wordpress.org:

• https://developer.wordpress.org/plugins/wordpress-org/previews-and-blueprints/

Here's what still missing:

• Blueprints developer documentation blueprints#2
• Update the woocommerce-product-feed blueprint.json blueprints#64
• Playground Documentation overhaul wordpress-playground#772
• Playground User Documentation wordpress-playground#1074

I will greatly appreciate your help with either of these items. Most importantly, what types of resources would be the most useful to start with (tutorials, how-tos, explanations, API references) and how to structure them. I wonder, should we hop on a call to get in sync?

What you've mentioned in the other thread would also go a long way towards building awareness and winning over developers and users.

When looking over and revising docs I'll keep the Playground in mind and make notes along the way... IE: create-block package > source code > try in Playground.

[flexseth]

@adamziel Happy to coordinate with you sometime to look at these. Please send me a DM on Slack at your convenience to schedule!

[adamziel]

Thank you @flexseth! I reached out, let's coordinate.

Also, linking to this superb article and discussion: WordPress/developer-blog-content#198

[flexseth]

Significant effort has gone into this on the dev side, and @adamziel linked to the discussion on the end user docs.

Marking as closed as a duplicate