Skip to content

[docs] Updating host own playground page#3242

Open
fellyph wants to merge 15 commits intotrunkfrom
updating-host-own-playground-page
Open

[docs] Updating host own playground page#3242
fellyph wants to merge 15 commits intotrunkfrom
updating-host-own-playground-page

Conversation

@fellyph
Copy link
Collaborator

@fellyph fellyph commented Feb 4, 2026

This pull request significantly improves the documentation for self-hosting and using WordPress Playground by clarifying setup expectations, adding troubleshooting guidance, and expanding details on browser compatibility and performance. The updates also enhance the limitations documentation with clearer explanations, practical tips, and improved formatting for easier navigation.

Improvements to self-hosting documentation:

  • Added a new "Before you start" section detailing setup complexity, static file hosting requirements, and browser-based execution for self-hosting Playground. Also included performance considerations and a browser compatibility matrix, with specific notes for Safari and mobile browsers.
  • Introduced a comprehensive production deployment checklist covering server configuration (MIME types, CORS, caching, compression, HTTPS) and performance optimization (CDN, pre-installed plugins, minimal blueprints).
  • Added a troubleshooting section with common issues, causes, and solutions for loading failures, slow startup, and Safari-specific problems.

Enhancements to limitations and usage documentation:

  • Clarified the temporary nature of Playground instances, explained why work is lost on browser refresh, and provided instructions for persisting changes using the "Save" button or Playground CLI. Added a tip about the difference between the Playground and browser refresh buttons, with a supporting image.
  • Improved documentation structure by adding anchor links to major sections and subsections for easier navigation.
  • Added a new "Performance expectations" section, including a table of typical load times for different scenarios and factors affecting performance, such as plugin size, network speed, device memory, and browser differences.

…led explanations on browser behavior, performance expectations, and persistence options. Added a new image for the refresh button and improved section headings for clarity.
@fellyph fellyph requested review from adamziel and Copilot and removed request for Copilot February 4, 2026 14:14
@brandonpayton brandonpayton self-requested a review February 4, 2026 14:43
Copy link
Member

@brandonpayton brandonpayton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fellyph I left some suggestions but this looks great overall. Thank you!

Comment on lines 15 to 19
### What to expect

- **Initial setup complexity**: Building and deploying Playground involves multiple steps. Allow time for troubleshooting during your first deployment.
- **Static file hosting**: Playground is primarily static files (HTML, JS, WASM) with minimal server-side requirements.
- **Browser-based execution**: All WordPress processing happens in the user's browser via WebAssembly—your server only delivers files.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are great.

| Fresh WordPress (no plugins) | 5-10 seconds |
| With small plugins | 10-20 seconds |
| With large plugins (e.g., WooCommerce) | 30-60 seconds |
| On mobile devices | 1.5-2x slower than desktop |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sure some folks will complain that their experience varies from these estimates, but it seems so good to have these to set expectations.

Copy link
Collaborator Author

@fellyph fellyph Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we set 5+ seconds, 10+ seconds and 30+ ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brandonpayton I will include this image:

Image

…r-own-playground.md

Co-authored-by: Brandon Payton <brandon@happycode.net>
Copilot AI review requested due to automatic review settings February 4, 2026 17:03
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances documentation for self-hosting WordPress Playground and clarifies its limitations, focusing on setup expectations, performance characteristics, and troubleshooting guidance.

Changes:

  • Added comprehensive pre-deployment guidance covering complexity, performance factors, and browser compatibility
  • Expanded limitations documentation with clearer explanations of temporary instances, persistence options, and performance expectations
  • Introduced production deployment checklist and troubleshooting section for common self-hosting issues

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
packages/docs/site/docs/developers/24-limitations/01-index.md Added anchor links, expanded temporary instance explanation with persistence instructions, added performance expectations table, and improved browser support details
packages/docs/site/docs/developers/23-architecture/18-host-your-own-playground.md Added "Before you start" section with setup expectations and browser compatibility matrix, production deployment checklist, and troubleshooting guide
Comments suppressed due to low confidence (1)

packages/docs/site/docs/developers/24-limitations/01-index.md:1

  • Corrected spacing in 'blueprints,for' to 'blueprints, for'.
---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants