docs: add verify installation commands#6202
docs: add verify installation commands#6202kokatenikita77 wants to merge 1 commit intowp-cli:mainfrom
Conversation
Adds a short section showing how to verify WP-CLI works after install.
Summary of ChangesHello @kokatenikita77, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request improves the project's documentation by introducing a dedicated section for verifying the WP-CLI installation. This addition aims to streamline the user onboarding process, allowing new users to quickly and confidently confirm their setup after following the initial installation instructions. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a helpful 'Verify installation' section to the README. However, the new documentation has a formatting error with an unclosed code block that will break page rendering. Additionally, the new section is placed in a confusing order, appearing before the instructions to make the wp command globally available. My review includes a fix for the formatting and a recommendation to reorder the sections for better clarity.
| ### Verify installation | ||
|
|
||
| After moving the executable to your PATH, confirm the `wp` command works: | ||
|
|
||
| ```bash | ||
| wp --info | ||
| wp --version | ||
|
|
||
|
|
There was a problem hiding this comment.
Thanks for adding this verification step. There are a couple of issues with this new section:
- Unclosed Code Block: The
bashcode block is not closed with backticks (```). This will cause rendering issues for the rest of the document. - Logical Order: This section is placed before the instructions to move the executable to the user's PATH. This is confusing because it asks the user to run the
wpcommand before it has been made available system-wide. This section should be moved after thechmodandmvcommand examples (currently on lines 78-83).
The suggestion below fixes the unclosed code block. Please also move the corrected block to the right place in the installation flow.
| ### Verify installation | |
| After moving the executable to your PATH, confirm the `wp` command works: | |
| ```bash | |
| wp --info | |
| wp --version | |
| ### Verify installation | |
| After moving the executable to your PATH, confirm the `wp` command works: | |
| ```bash | |
| wp --info | |
| wp --version |
github-actions
bot
added
command:cli-info
|
Hello! 👋 Thanks for opening this pull request! Please check out our contributing guidelines. We appreciate you taking the initiative to contribute to this project. Contributing isn't limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation. Here are some useful Composer commands to get you started:
To run a single Behat test, you can use the following command: # Run all tests in a single file
composer behat features/some-feature.feature
# Run only a specific scenario (where 123 is the line number of the "Scenario:" title)
composer behat features/some-feature.feature:123You can find a list of all available Behat steps in our handbook. |
|
Hi maintainers, I added a small “Verify installation” section with example commands to help new users confirm WP-CLI is installed correctly. Please let me know if you’d like any adjustments. |
This comment was marked as resolved.
This comment was marked as resolved.
|
Thanks for your contribution. Curious, what prompted this change? I don't think this step was ever a big issue with our users when onboarding to WP-CLI. IMO, if we want to update this section we also need to look at https://wp-cli.org/ and https://make.wordpress.org/cli/handbook/guides/installing/ which also have installation instructions. They would need to be in sync, but we also shouldn't repeat ourselves everywhere. My suggestion is to first open an issue to discuss this properly before making any documentation changes. |
2 participants
Adds a small "Verify installation" section with example commands to confirm WP-CLI is installed and available in PATH.