Add beginner-friendly documentation for non-technical WP-CLI users#629
Merged
swissspidy merged 10 commits intomainfrom Mar 17, 2026
Merged
Add beginner-friendly documentation for non-technical WP-CLI users#629swissspidy merged 10 commits intomainfrom
swissspidy merged 10 commits intomainfrom
Conversation
…dates Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve documentation for non techies
Add beginner-friendly documentation for non-technical WP-CLI users
Mar 17, 2026
This comment was marked as resolved.
This comment was marked as resolved.
…p help, SSH guidance Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
This comment was marked as resolved.
This comment was marked as resolved.
swissspidy
reviewed
Mar 17, 2026
…ents to installing.md Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
This comment was marked as resolved.
This comment was marked as resolved.
Closed
…oper guide separation Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
This comment was marked as resolved.
This comment was marked as resolved.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the WP-CLI handbook’s “Guides” section for new users by adding two new introductory pages, updating the main index to group guides by audience, and registering the new pages (and a few existing ones) in the handbook manifest used for WordPress.org imports.
Changes:
- Add new “Beginner’s Guide” and “Common Tasks with WP-CLI” guide pages.
- Reorganize
index.mdto split guides into “For users” and “For developers”, and adjust the guide list accordingly. - Add a “Requirements” section to the Installing guide and update
bin/handbook-manifest.jsonto include new/relocated entries.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| index.md | Re-groups guide links into user/developer sections and adds new guide links. |
| guides/installing.md | Adds a new Requirements section describing PHP minimum version. |
| guides/common-tasks.md | Introduces a new task-oriented guide with command examples. |
| guides/beginners-guide.md | Introduces a new beginner-focused guide explaining the command line and first WP-CLI steps. |
| bin/handbook-manifest.json | Registers new handbook pages and adjusts manifest entries for import. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The handbook is developer-focused, leaving non-technical WordPress users without a clear entry point for learning WP-CLI.
New guides
guides/beginners-guide.md— A linear user manual designed to be read from start to finish. Explains what the command line is, how to open a terminal on macOS/Windows/Linux, basic shell navigation, what WP-CLI is, and how to read WP-CLI output. Also covers running WP-CLI inside vs. outside the WordPress folder, usingwp helpfor built-in documentation, community support resources, and how to use WP-CLI on a remote server over SSH. Links to the existing installation guide rather than duplicating installation steps.guides/common-tasks.md— Practical command reference organized by topic (plugins, themes, core, users, posts, comments, options, search-replace, media, cache, database). Each entry is a short description + copy-paste command. Includes a note on Windows shell-substitution compatibility for commands using$(...).Updated
index.md— Promotes the two new guides to the top of the Guides section. Splits the Guides section into "For users" (Beginner's guide, Common tasks, Installing, Quick start, Running commands remotely, Common issues, External resources, Troubleshooting) and "For developers" (Commands cookbook, Writing Behat Tests, and other developer-oriented guides) to clearly separate user-facing from developer-oriented content.guides/installing.md— Added a new## Requirementssection documenting the PHP 7.2.24 minimum version requirement, placed before the installation instructions.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.