[Documentation] Adding Playground CLI page and removing wp-now references #2337

fellyph · 2025-07-07T17:07:53Z

Motivation for the change, related issues

Due to the deprecation of the wp-now and the rollout of the new playground CLI(#2224). This pull request updates the references from wp-now to @wp-playground/cli and creates a new page showing how to use the new playground CLI.

Implementation details

Updating the main README file
Adding a deprecation notice on wp-now page
Creating the new Playground CLI page
Updating Local Development, Contributor Day, Build and Theme/Plugins for developers pages.

Testing Instructions (or ideally a Blueprint)

Download the branch adding-playground-cli-page
Install the dependencies
Run the command npm run dev:docs

adamziel · 2025-07-08T08:50:04Z

packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md

+Some projects have a specific structure that requires a custom configuration, for example, your repo contains all the files from the `/wp-content/` folder. So this scenario you can specify to the Plaground CLI you will mount your project from that folder using the flag `--mount`.
+
+```bash
+npx @wp-playground/cli@latest server --mount=.:/wordpress/wp-content/plugins/


Nice! Just noticing we'll need to coordinate updating this with merging #2281 as that will break some CLI BC.

packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md

adamziel · 2025-07-08T08:56:15Z

Nice! Thank you @fellyph. Good direction, I've just left some notes. Btw, are we duplicating the CLI readme with that page? I wonder if there's a way to symlink one to the other perhaps? Or would you say they're distinct?

packages/docs/site/docs/developers/05-local-development/01-wp-now.md

packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md

bgrgicak · 2025-07-11T05:09:29Z

packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md

+On Windows, the path format `/host/path:/vfs/path` can cause issues. To resolve this, use the flags `--mount-dir` and `--mount-dir-before-install`. These flags let you specify host and virtual file system paths in an alternative format`"/host/path"` `"/vfs/path"`.
+:::
+
+## Command and Arguments


Is there something in Docusaurus that would enable us to auto-generate this section? I'm concerned about it getting outdated.

packages/docs/site/docs/main/contributing/contributor-day.md

…now.md Co-authored-by: Bero <[email protected]>

…playground-cli.md Co-authored-by: Bero <[email protected]>

Co-authored-by: Bero <[email protected]>

…playground-cli.md Co-authored-by: Bero <[email protected]>

adamziel · 2025-07-14T15:22:57Z

It seems like there are some build failures

…playground-cli.md Co-authored-by: Bero <[email protected]>

fellyph · 2025-07-14T16:25:00Z

@adamziel I have updated the branch, let's see if the CI passes now.

adamziel · 2025-07-14T17:04:04Z

It seems like there's still a missing image error

adamziel · 2025-07-14T20:48:57Z

When I go to the build job failure details and scroll all the way down, the error says:

  [ERROR] Client bundle compiled with errors therefore further build is impossible.
  Error: MDX compilation failed for file "/home/runner/work/wordpress-playground/wordpress-playground/packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md"
  Cause: Image docs/developers/05-local-development/_assets/npx-wp-playground-server.gif used in docs/developers/05-local-development/04-wp-playground-cli.md not found.
  Details:
  Error: Image docs/developers/05-local-development/_assets/npx-wp-playground-server.gif used in docs/developers/05-local-development/04-wp-playground-cli.md not found.
      at async Promise.all (index 0)

The relative path used in packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md says ./_assets/npx-wp-playground-server.gif and is pointing to a non-existent file. The actual asset is in ../../blueprints/_assets/npx-wp-playground-server.gif.

fellyph · 2025-07-15T09:44:51Z

I have fixed the image address and fixed the issue.

fellyph · 2025-07-15T09:59:31Z

I have removed wp-now from the documentation sidebar:

fellyph added 10 commits July 7, 2025 17:24

Adding new intro page

52840dd

Adding notice for wp-now deprecation

b5636e5

Updating readme file

29f171f

adding new page playground cli

db73d54

Updating resource page

6ccad1a

Updating build page

b8bf493

Updating contributor day page

93db410

Updating for developers page

9c95326

Updating the theme developers' page

4042682

Re-ordering text

4af1927

fellyph requested a review from a team as a code owner July 7, 2025 17:07

fellyph requested a review from adamziel July 7, 2025 17:08

fellyph changed the title ~~Adding Playground cli page and removing wp-now references from the documentation~~ [Documentation] Adding Playground cli page and removing wp-now references Jul 7, 2025

fellyph changed the title ~~[Documentation] Adding Playground cli page and removing wp-now references~~ [Documentation] Adding Playground CLI page and removing wp-now references Jul 7, 2025

fellyph added the [Type] Documentation Improvements or additions to documentation label Jul 7, 2025

adamziel reviewed Jul 8, 2025

View reviewed changes

packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Outdated Show resolved Hide resolved

adamziel reviewed Jul 8, 2025

View reviewed changes

packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md Show resolved Hide resolved

fellyph added 5 commits July 8, 2025 12:24

adding animated gif for the page and fixing command blocks

bc7119e

fixing command blocks

d646818

re-ordering content, fixing typos and add manual mounting scenarios.

426c768

Merge branch 'trunk' into adding-playground-cli-page

dc5871d

Merge branch 'trunk' into adding-playground-cli-page

2077f2d

bgrgicak reviewed Jul 11, 2025

View reviewed changes

fellyph and others added 5 commits July 11, 2025 10:29

Update packages/docs/site/docs/developers/05-local-development/01-wp-…

790a950

…now.md Co-authored-by: Bero <[email protected]>

Update packages/docs/site/docs/developers/05-local-development/04-wp-…

3113774

…playground-cli.md Co-authored-by: Bero <[email protected]>

Update packages/docs/site/docs/developers/05-local-development/04-wp-…

4bc48f2

…playground-cli.md Co-authored-by: Bero <[email protected]>

Update packages/docs/site/docs/developers/05-local-development/04-wp-…

e6ff7e6

…playground-cli.md Co-authored-by: Bero <[email protected]>

Update packages/docs/site/docs/developers/05-local-development/04-wp-…

7f660a0

…playground-cli.md Co-authored-by: Bero <[email protected]>

fellyph and others added 3 commits July 11, 2025 10:33

Update packages/docs/site/docs/main/contributing/contributor-day.md

e991da6

Co-authored-by: Bero <[email protected]>

Update packages/docs/site/docs/developers/05-local-development/04-wp-…

edc73be

…playground-cli.md Co-authored-by: Bero <[email protected]>

Merge branch 'trunk' into adding-playground-cli-page

a6271dc

fellyph and others added 4 commits July 14, 2025 16:44

Merge branch 'trunk' into adding-playground-cli-page

66f261f

Update packages/docs/site/docs/developers/05-local-development/04-wp-…

ef6ac78

…playground-cli.md Co-authored-by: Bero <[email protected]>

Update packages/docs/site/docs/developers/05-local-development/04-wp-…

d5f9a3f

…playground-cli.md Co-authored-by: Bero <[email protected]>

applying suggestion for clarity on this paragraph

9ba0af7

Merge branch 'trunk' into adding-playground-cli-page

038dfe4

fellyph added 3 commits July 15, 2025 10:40

Moving npx-wp-playground-server to the static image folder

40e6918

moving gif to the developers folder

83429af

Merge branch 'trunk' into adding-playground-cli-page

895a433

Removing wp-now from the documentation sidebar

9a51c6b

adamziel merged commit 62b0990 into trunk Jul 15, 2025
24 of 25 checks passed

adamziel deleted the adding-playground-cli-page branch July 15, 2025 10:46

fellyph mentioned this pull request Aug 4, 2025

What's new for developers? (August 2025) WordPress/developer-blog-content#381

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Documentation] Adding Playground CLI page and removing wp-now references #2337

[Documentation] Adding Playground CLI page and removing wp-now references #2337

fellyph commented Jul 7, 2025

Uh oh!

adamziel Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

adamziel commented Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bgrgicak Jul 11, 2025

Uh oh!

Uh oh!

adamziel commented Jul 14, 2025

Uh oh!

fellyph commented Jul 14, 2025

Uh oh!

adamziel commented Jul 14, 2025

Uh oh!

adamziel commented Jul 14, 2025

Uh oh!

fellyph commented Jul 15, 2025

Uh oh!

fellyph commented Jul 15, 2025

Uh oh!

Uh oh!

Uh oh!

[Documentation] Adding Playground CLI page and removing wp-now references #2337

[Documentation] Adding Playground CLI page and removing wp-now references #2337

Conversation

fellyph commented Jul 7, 2025

Motivation for the change, related issues

Implementation details

Testing Instructions (or ideally a Blueprint)

Uh oh!

adamziel Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

adamziel commented Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bgrgicak Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adamziel commented Jul 14, 2025

Uh oh!

fellyph commented Jul 14, 2025

Uh oh!

adamziel commented Jul 14, 2025

Uh oh!

adamziel commented Jul 14, 2025

Uh oh!

fellyph commented Jul 15, 2025

Uh oh!

fellyph commented Jul 15, 2025

Uh oh!

Uh oh!

Uh oh!