Documentation updates for Yoast's Online Contributor Day ⭐️

[flexseth]

Contributing

Thank you for considering being a part of the Playground today! We've been working hard on figuring out where the gaps in documentation lie, and want to start providing as much information as possible for how the platform works.

Here is a list of items that have been discussed that can be documented, created, improved, tested, etc.

Introduction

• https://github.com/WordPress/wordpress-playground/wiki/Contributing-Documentation-at-Contributor-Day
• https://wordpress.github.io/wordpress-playground/contributing/documentation/
• Docs: Contributing to end user documentation using Playground #1254

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

Getting started with contributing to the Playground docs

• https://wordpress.github.io/wordpress-playground/contributing/documentation/

Please feel free to use any starter docs you see in the Playground Docs Updates repo to improve on or submit as PRs.

I will be available and have access to assign issues to contributors in the WordPress Playground repo, for anyone who wants to take on a project. @flexseth in the Yoast Slack Chat!

---

Docs updates requested

How to use Playground to...

• Playground User Documentation #1074
  Long list of docs requested
• Blueprints onboarding documentation blueprints-library#64
  Ideas for Yoasters
• https://github.com/flexseth/playground-docs-updates/blob/trunk/yoast-online-contributor-day-april-18-2024.md
• Improve migration docs: import/export WordPress sites with Playground #1166

---

Blueprints - creating and documenting how they work

Ten ideas - or so - to get started

• Add 10 initial Blueprints blueprints#1
• Further down the post there's a long list of ideas with pseudocode

Plugins

Using Blueprints with plugins

How to import theme test data (detailed instructions)

• Advanced Query Loop by Ryan Welcher demo

✅ Testing an "out of date" plugin: PressThis

• https://github.com/flexseth/playground-docs-updates/blob/trunk/testing/updating-a-plugin.md
• Remove error warning on WordPress.org by testing in Playground
• https://github.com/flexseth/playground-docs-updates/tree/press-this_compatibility-check-6.5/compat_check

mu-plugins examples

• add_filter example
• Block Hooks example also listed on this post

Themes

• Docs: How to build a WordPress theme in WordPress Playground? #1257

How to demo a theme or plugin?

• Docs: How to demo your theme or your plugin with Playground? #1255

Theme blueprint examples

thread

• Twenty Twenty with block template parts.
• Twenty Twenty with theme.json.
• Twenty Twenty with theme.json and various block options for color limited.
• Twenty Twenty-Four with locked blocks or patterns (including content only editing).
• Twenty Twenty-Four with both theme provided and custom starter patterns, along with patterns prioritized from the pattern directory.
• Twenty Twenty-Four with various block options limited (duotone, color, typography tools) and client side filtering for some blocks.

Systems info

Architecture related documentation

Using the VS Code Extension

• Lots of docs needed here!
• Working locally with Playground using the VS Code Extension #1169

wp-now "boot modes"

• slightly technical, but if you have experience with wp-now and the playground, we are looking to really improve the understanding of how the "boot modes" work

VS Code vs. wp-now

• Docs: Explain Playground vs wp-now vs VS Code extension #1256

Testing

See Testing in Playground for docs and update opportunities

QR Code demos

The idea is to be able to showcase a demo by having someone click a QR Code.
Imagine you're at a networking meeting and want to show off how awesome Playground is, or what you created with it. Being able to click a QR Code and go to an instance of a fully functioning website - is the idea.

Helping to add pseudocode or steps, description information to any of the ideas below would be helpful. They will be included in documentation with your help!

• Using Jetpack in Playground via a Blueprint
  • https://github.com/flexseth/playground-docs-updates/blob/trunk/qr-code-demos/jetpack.md
  • Jetpack site - show all features (available w/out auth)
• WooCommerce demo
• Playground Documentation onboarding
• Import / Export website demo
• Brochure site with patterns as pages
• create-block demo - Easily make a custom block for Gutenberg
• Core Blocks demo - showcase using a couple of WordPress (React) core components
• Demo a block someone else has made (Interactivity API Countdown)
• Roll five websites for students to work on
• API demo
• Custom plugin demo - Roll your own plugin
• LMS demo w/Sensei
• GitHub Issues Connect block plugin - create a new issue about this block
• Screenshot block - utility - using a NPM package with Playground
• Testing Playground - create e2e tests
• Plugin Review Check - boot in Plugin mode to test against submission guidelines

Explaining errors

• Docs: Explain networking #1193

Error when trying to run a custom domain

• wp-now: Error starting: getaddrinfo ENOTFOUND new-playground1.wpnow adamziel/playground-docs-workflow#32

Explaining options for the Blueprint data format

• Docs update proposal: Provide more info on features, extensions? #1208
• features
• networking
• kitchen sink
• etc

[adamziel]

Closing as the Contributor Day is finished.