From 3f1fb452985cddd45605e9b48c7aa9492066005f Mon Sep 17 00:00:00 2001 From: Mehraz Morshed Date: Thu, 25 Dec 2025 12:20:33 +0600 Subject: [PATCH 1/2] Improve grammar and clarity in command setup instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Refined grammar, punctuation, and wording in the command setup instructions to improve clarity and readability. This change does not alter behavior or meaning—only documentation quality. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 456ed535..1f3c1bab 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Long-form documentation (e.g. "Commands cookbook") can be edited directly. Internal API docs and command pages are generated dynamically from the WP-CLI codebase using the `wp handbook` series of commands. -Before running these commands the bash script `bin/install-packages.sh` should be run to install the latest versions of the non-bundled commands in `bin/packages`. Note `wp` must point to the target WP-CLI instance, i.e. the phar/git that contains the docblocks to be generated against, and should be run with `WP_CLI_PACKAGES_DIR=bin/packages` and `WP_CLI_CONFIG_PATH=/dev/null`. +Before running these commands, the bash script `bin/install-packages.sh` should be run to install the latest versions of the non-bundled commands in `bin/packages`. Note that `wp` must point to the target WP-CLI instance (i.e., the phar or git version that contains the docblocks to be generated against) and should be run with `WP_CLI_PACKAGES_DIR=bin/packages` and `WP_CLI_CONFIG_PATH=/dev/null`. So for instance to generate all dynamically created documentation against the nightly phar run: From f8cc09e428334ae51d3a4a67b4ae204c5c4611f4 Mon Sep 17 00:00:00 2001 From: Pascal Birchler Date: Sun, 28 Dec 2025 12:16:34 +0100 Subject: [PATCH 2/2] Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f3c1bab..1bd0632d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Long-form documentation (e.g. "Commands cookbook") can be edited directly. Internal API docs and command pages are generated dynamically from the WP-CLI codebase using the `wp handbook` series of commands. -Before running these commands, the bash script `bin/install-packages.sh` should be run to install the latest versions of the non-bundled commands in `bin/packages`. Note that `wp` must point to the target WP-CLI instance (i.e., the phar or git version that contains the docblocks to be generated against) and should be run with `WP_CLI_PACKAGES_DIR=bin/packages` and `WP_CLI_CONFIG_PATH=/dev/null`. +Before running these commands, the bash script `bin/install_packages.sh` should be run to install the latest versions of the non-bundled commands in `bin/packages`. Note that `wp` must point to the target WP-CLI instance (i.e., the phar or git version that contains the docblocks to be generated against) and should be run with `WP_CLI_PACKAGES_DIR=bin/packages` and `WP_CLI_CONFIG_PATH=/dev/null`. So for instance to generate all dynamically created documentation against the nightly phar run: