Skip to content

Commit 9152a82

Browse files
authored
[Documentation] Updating web instance page docs (#2365)
1 parent 25a3b83 commit 9152a82

8 files changed

+37
-25
lines changed

packages/docs/site/docs/main/web-instance.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,53 +9,65 @@ slug: /web-instance
99

1010
Some key features:
1111

12-
- **Browser-based**: No need for a local server setup.
12+
- **Browser-based**: No local server setup required.
1313
- **Instant Setup**: Run WordPress with a single click.
1414
- **Testing Environment**: Ideal for testing plugins and themes.
1515

16-
Via [Query Params](/developers/apis/query-api/) we can directly load in the Playground instance things such as a specific version of WordPress, a theme, a plugin or a more complex setup via blueprints (check [here](/quick-start-guide#try-a-block-a-theme-or-a-plugin) some examples).
16+
The [Query Params API](/developers/apis/query-api/) allows you to directly load specific configurations into a Playground instance. This includes setting a particular WordPress version, theme, or plugin. You can also define more complex setups using blueprints (see [examples here](/quick-start-guide#try-a-block-a-theme-or-a-plugin)).
1717

18-
From the Playground website there are also available some toolbars to customize your playground instance and to provide quick access to some resources and utilities.
18+
From the Playground website, some toolbars are also available to customize your Playground instance and provide quick access to some resources and utilities.
1919

20-
![Playground Toolbar Snapshot](./_assets/toolbar.png)
20+
![Playground Toolbar Snapshot](@site/static/img/about/toolbar-playground.webp)
2121

2222
## Customize Playground
2323

24-
![snapshot of customize playground window at playground instance](./_assets/customize-playground.png)
24+
On the toolbar, you'll find:
2525

26-
The options available from the "Customize Playground" window correpond to the following [Query API options](/developers/apis/query-api#available-options):
26+
- **Playground Settings**: A panel for configuring your current instance, like PHP and WordPress versions.
27+
- **Playground Manager**: This panel lets you manage WordPress Playground instances, allowing you to save, import, and export them.
2728

28-
- `php`
29-
- `php-extension-bundle`
30-
- `networking`
31-
- `wp`
29+
### Playground Settings
3230

33-
:::tip
31+
![snapshot of customize Playground window at Playground instance](@site/static/img/about/playground-settings-panel.webp)
3432

35-
You need to activate "Network access" to be able to browse for [plugins](https://w.org/plugins) and [themes](https://w.org/themes) from your WordPress instance.
36-
:::
33+
The options available from the **Playground Settings Panel**, correspond to the following [Query API options](/developers/apis/query-api#available-options):
3734

38-
## Playground Options Menu
35+
- `language`: Sets the WordPress instance language.
36+
- `multisite`: Enables WordPress multisite support.
37+
- `networking`: Grants network access, allowing fetches from the WordPress plugin directory and internal WordPress APIs.
38+
- `php`: Specifies the PHP version for the instance.
39+
- `wp`: Defines the WordPress version.
3940

40-
![options menu at playground instance snapshot](./_assets/options.png)
41+
## Playground Manager
4142

42-
This menu contains links to some Playground resources and tools:
43+
![Playground settings panel allow users to manage multiple instances](@site/static/img/about/playground-manager-panel.webp)
4344

44-
- **Reset Site**: - It will wipe out all data and reload the page with a new site.
45-
- **Report error**: If you have any issue with WP Playground you can report it using the form available from this option. You can help resolve issues with Playground by sharing the error details with development team behind Playground.
46-
- **Download as zip**: It creates a `.zip` with the setup of the Playground instance including any themes or plugins installed. This `.zip` won't include content and database changes.
47-
- **Restore from zip**: It allows you to recreate a Playground instance using any `.zip` generated with the "Download as zip" option
48-
- **Import from Github**: This option allows you to import plugins, themes, and wp-content directories directly from your public GitHub repositories. To enable this feature, connect your GitHub account with WordPress Playground.
45+
This panel enables users to manage Playground instances. It displays a list of saved Playgrounds and provides access to the current Playground's settings, along with a **Save Button** to store your configurations locally in your browser for later reloading.
4946

50-
- **Export Pull Request to GitHub**: This option allows you to export WordPress plugins, themes, and entire wp-content directories as pull requests to any public GitHub repository. Check [here](https://www.youtube.com/watch?v=gKrij8V3nK0&t=2488s) a demo of using this option.
47+
![Save Playground Button](@site/static/img/about/playground-manager-save-instance.webp)
48+
49+
Once you click on save, an instance will be stored with a generated name to be revisited anytime. The Playground Manager also has options to export(Additional actions menu) and import(Import actions menu) WordPress Playground instances:
50+
51+
### Additional actions menu
5152

52-
- **View Logs**: This option will take you to modal that will show any error logs for Playground, WordPress and PHP.
53+
![Additional actions Menu](@site/static/img/about/playground-manager-additional-actions.webp)
5354

54-
- **Edit the blueprint**: This option will open the current blueprint used for the Playground instance in the [Blueprints Builder tool](https://playground.wordpress.net/builder/builder.html). From this tool you'll be able to edit the blueprint online and run a new Playground instance with your edited version of the blueprint.
55+
- **Export Pull Request to GitHub**: This option allows you to export WordPress plugins, themes, and entire wp-content directories as pull requests to any public GitHub repository. Check [here](https://www.youtube.com/watch?v=gKrij8V3nK0&t=2488s) a demo of using this option.
56+
- **Download as zip**: It creates a `.zip` with the setup of the Playground instance, including any themes or plugins installed. This `.zip` won't include content and database changes.
57+
- **Report error**: If you have any issues with WP Playground, you can report it using the form available from this option. You can help resolve issues with Playground by sharing the error details with the development team behind Playground.
58+
- **View Blueprint**: This option will open the current blueprint used for the Playground instance in the [Blueprints Builder tool](https://playground.wordpress.net/builder/builder.html). From this tool you'll be able to edit the blueprint online and run a new Playground instance with your edited version of the blueprint.
5559

5660
<span id="edit-the-blueprint"></span>
5761

58-
[![snapshot of Builder mode of WordPress Playground](./_assets/builder-mode.png)](https://playground.wordpress.net/builder/builder.html)
62+
[![snapshot of Builder mode of WordPress Playground](@site/static/img/about/blueprint-builder.webp)](https://playground.wordpress.net/builder/builder.html)
63+
64+
### Import actions menu
65+
66+
![Import actions Menu](@site/static/img/about/playground-manager-import-actions.webp)
67+
68+
- **Import from zip**: It allows you to recreate a Playground instance using any `.zip` generated with the "Download as zip" option.
69+
- **Preview a Gutenberg PR**: Allow testers run branches from the Gutenberg repository to test pull requests instantly.
70+
- **Import from GitHub**: This option allows you to import plugins, themes, and wp-content directories directly from your public GitHub repositories. To enable this feature, connect your GitHub account with WordPress Playground.
5971

6072
:::caution
6173

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)