[Docs] Updating run cli demos by fellyph · Pull Request #2833 · WordPress/wordpress-playground

fellyph · 2025-10-28T11:14:12Z

Motivation for the change, related issues

Updating the runCLI demos to show other ways of working with the method, applying for tests. Including more examples of the new flags. The change also included a description to improve the page SEO and apply some recommendations of the WordPress Docs handbook.

New demos:

Setting a custom site URL
Multiple mounts
Symlink support for monorepos
Testing plugins with specific PHP versions
Mode selection (Blueprint v2)
Skip WordPress and SQLite setup
Error handling
Following symlinks programmatically

Portuguese and Spanish versions are also included.

adamziel

Really cool, thank you! I've left a few comments, nothing major.

fellyph · 2025-11-10T18:08:31Z

@adamziel I have removed the blueprints v2 examples temporarily and added the suggested changes

Streamline the CLI docs page and add a new dedicated guide for programmatic usage of the Playground CLI. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

This PR updates the runCLI documentation by moving the programmatic usage content from the CLI reference page into a dedicated guide page with expanded examples, and adds that new guide to the site's sidebar and index.

Changes:

Adds a new programmatic-playground-cli.md guide with comprehensive runCLI examples covering blueprints, mounts, testing, error handling, and advanced configuration.
Replaces the existing inline programmatic usage section in 04-wp-playground-cli.md with a short summary linking to the new guide.
Registers the new guide in the sidebar and the guides index page.

Reviewed changes

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

File	Description
`packages/docs/site/sidebars.js`	Adds the new guide to the sidebar navigation
`packages/docs/site/docs/main/guides/programmatic-playground-cli.md`	New dedicated guide page with expanded `runCLI` examples
`packages/docs/site/docs/main/guides/index.md`	Adds an entry for the new guide on the guides index page
`packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md`	Replaces old inline programmatic usage section with a link to the new guide

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

…i.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

… Playground CLI guide This commit introduces new documentation files for the programmatic usage of the Playground CLI in Spanish, French, and Portuguese. The guides cover how to use the `runCLI` function for automation and testing, including examples for running WordPress instances, setting blueprints, and conducting automated tests. These additions enhance accessibility and support for non-English speaking users, ensuring comprehensive guidance on utilizing the Playground CLI effectively.

…/wordpress-playground into updating-run-cli-demos

mho22

Except my comments, even if you decide to take them into account or only parts of them, this pull request is approved!

beryl-dlg

## Monter un **plugin** de manière programmatique
## Monter une extension de manière programmatique

Word translation : extension instead of plugin

mho22 · 2026-03-05T14:45:33Z

@beryl-dlg Un grand merci!

Updated variable declarations from `let` to `const` for `cliServer` in the programmatic Playground CLI guides across English, Spanish, and French documentation. This change enhances code clarity and enforces best practices in variable usage.

…tion Updated variable declarations from `let` to `const` for `cliServer` in the Portuguese version of the programmatic Playground CLI guide. This change improves code clarity and adheres to best practices in variable usage.

Updated the Playground CLI documentation in Spanish, Japanese, and Portuguese to improve clarity and consistency. Key changes include the addition of detailed descriptions for the `start` and `server` commands, requirements for Node.js, and automatic site persistence features. This update aims to provide comprehensive guidance for users in these languages, ensuring a better understanding of the Playground CLI functionalities.

…ltiple languages Updated variable declarations from `let` to `const` for `cliServer` in the programmatic Playground CLI guides across English, Spanish, French, and Portuguese documentation. This change enhances code clarity and adheres to best practices in variable usage.

Revised several phrases in the French version of the programmatic Playground CLI guide to enhance clarity. Changes include specifying "version PHP 8.3" and "environnement d'éxécution Typescript" for better understanding. Additionally, the term "extension" was used instead of "plugin" to align with French terminology.

### Motivation for the change, related issues English docs/main/guides/index.md now lists 13 guides, including PHP snippets ([#3644](#3644)), PHP frameworks ([#3766](#3766)), Playground for Everyone ([#3103](#3103)), Blueprint content import ([#4032](#4032)), PR preview buttons ([#2893](#2893)), the agent skill ([#3282](#3282)), runCLI ([#2833](#2833)), PHPUnit ([#3487](#3487)), and Playwright E2E ([#3360](#3360)). The Tagalog index still had only the iOS, demo content, theme, and plugin guides. /tl/guides readers would miss the newer entries, even though Docusaurus can fall back to English for pages that are not translated yet. ### Implementation details 1. Updated packages/docs/site/i18n/tl/docusaurus-plugin-content-docs/current/main/guides/index.md. 2. Expanded the frontmatter description to match English. 3. Kept and aligned the four existing Tagalog entries (iOS / Blocknotes, demo content, theme developers, plugin developers). 4. Added Tagalog blurbs for the nine missing guides, in the same order as English. 5. Kept the original English above each block in HTML comments, per the translation guide. 6. Testing Instructions (or ideally a Blueprint) 7. Docs-only change; no Blueprint.  ## Summary by CodeRabbit - **Documentation** - Expanded the Tagalog guides index from 4 to 13 guide links. - Added translated guides covering PHP snippets and embeds, PHP frameworks, WordPress Playground, Blueprints, GitHub Actions, the Playground Agent Skill, CLI usage, PHPUnit, and Playwright testing. - Revised the page description, introduction, and existing guide sections for clearer Tagalog-language guidance.

fellyph requested a review from adamziel October 28, 2025 11:14

fellyph added [Type] Documentation Improvements or additions to documentation [Aspect] Internationalization (i18n) labels Oct 28, 2025

adamziel reviewed Oct 28, 2025

View reviewed changes