Skip to content

Commit 4cb13a5

Browse files
authored
Merge pull request #68 from woocommerce/docs/minor-fixes
Minor docs fixes (capitalization and phrasing)
2 parents db53a3e + 72afef7 commit 4cb13a5

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

docs/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ QIT (Quality Insights Toolkit) is a testing platform developed by WooCommerce fo
1414
**Key Features:**
1515
- **Managed test suites:** Run pre-configured end-to-end tests, activation tests, security scans, PHPStan analysis, API tests, and more.
1616
- **Custom E2E testing:** Write and run your own Playwright-based E2E tests directly through QIT.
17-
- **Continuous quality checks:** Easily integrate QIT with your development workflows (CLI, GitHub Actions, etc.).
17+
- **Continuous quality checks: Seamlessly integrate QIT into your development workflows via CLI, GitHub Actions, and more.
1818
- **Marketplace integration:** Currently in closed beta for extensions listed on the WooCommerce Marketplace.
1919

2020
<video controls style={{ width:"100%", height:"100%" }}>
@@ -24,7 +24,7 @@ QIT (Quality Insights Toolkit) is a testing platform developed by WooCommerce fo
2424

2525
## Requirements
2626

27-
- **Woocommerce.com partner developer account:** You must have at least one extension listed on the WooCommerce.com Marketplace to access QIT.
27+
- **WooCommerce.com partner developer account:** You must have at least one extension listed on the WooCommerce.com Marketplace to access QIT.
2828
- **PHP 7.2.5+ and composer:** Required if you plan to use QIT locally via the CLI.
2929

3030
## Quick start guide
@@ -86,7 +86,7 @@ While full QIT access is currently exclusive to WooCommerce.com Partner Develope
8686
## Ways to use QIT
8787

8888
- **Command line (CLI):** Perfect for integrating into your local development workflow or CI pipelines. See [CLI Getting Started](./installation-setup/cli-installation.md).
89-
- **Woocommerce.com dashboard:** Run and view tests directly in the vendor dashboard UI. See [Getting Started with Dashboard](./using-qit/running-tests-dashboard.md).
89+
- **WooCommerce.com dashboard:** Run and view tests directly in the vendor dashboard UI. See [Getting Started with Dashboard](./using-qit/running-tests-dashboard.md).
9090
- **GitHub actions:** Integrate QIT tests into your GitHub workflows. See [GitHub Workflows Setup](./using-qit/github-workflows.md).
9191

9292
:::info

docs/managed-tests/plugin-check.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# wordpress.org Plugin Check tests
1+
# WordPress.org Plugin Check tests
22

3-
wordpress.org Plugin Check tests run the [wordpress.org automated plugin check](https://wordpress.org/plugins/plugin-check) tool against your extension. This optional test focuses on guidelines and patterns important for submitting plugins to the WordPress.org directory.
3+
WordPress.org Plugin Check tests run the [WordPress.org automated plugin check](https://wordpress.org/plugins/plugin-check) tool against your extension. This optional test focuses on guidelines and patterns important for submitting plugins to the WordPress.org directory.
44

55
**Note:** Currently, these checks are not automatically triggered for WooCommerce Marketplace submissions. They are available for developers who also distribute on wordpress.org or wish to maintain broader WordPress best-practices.
66

@@ -9,13 +9,13 @@ wordpress.org Plugin Check tests run the [wordpress.org automated plugin check](
99
The tool currently runs checks from the `plugin_repo` category, which helps identify violations of the [WordPress.org Plugin Review Guidelines](https://make.wordpress.org/plugins/handbook/performing-reviews/review-checklist/). These may include:
1010

1111
- **Core guideline compliance:** Detects code that violates mandatory directory rules.
12-
- **Repository readiness:** Flags improper file structures, disallowed functions, or patterns that could prevent listing on wordpress.org.
12+
- **Repository readiness:** Flags improper file structures, disallowed functions, or patterns that could prevent listing on WordPress.org.
1313
- **General code health:** May highlight deprecated functions, insecure code usage, or general best-practice concerns.
1414

1515
## Interpreting results
1616

1717
- **Success:** No major issues detected.
18-
- **Warnings/Failures:** Potential guideline violations or best-practice deviations are highlighted. While not necessarily blocking for WooCommerce Marketplace, they could impact your plugin’s acceptability on wordpress.org.
18+
- **Warnings/Failures:** Potential guideline violations or best-practice deviations are highlighted. While not necessarily blocking for WooCommerce Marketplace, they could impact your plugin’s acceptability on WordPress.org.
1919

2020
## Next steps if it fails
2121

docs/support/faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A: Full QIT functionality, including managed tests and cloud runs, requires a Wo
1111
## Installation and setup
1212

1313
**Q: How do I install the QIT CLI?**
14-
Please refer to the [CLI Installation](../installation-setup/cli-installation.md) page for instrutions on installing the QIT CLI.
14+
Please refer to the [CLI Installation](../installation-setup/cli-installation.md) page for instructions on installing the QIT CLI.
1515

1616
**Q: What are the prerequisites for running tests locally?**
1717
Please check the [Local Test Environment Introduction](../environment/introduction.md) for more details.

docs/test-execution/useful-commands.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Displays info such as:
5555
```
5656
Run Id 344745
5757
Test Type security
58-
Wordpress Version 6.1.1
59-
Woocommerce Version 7.2.2
58+
WordPress Version 6.1.1
59+
WooCommerce Version 7.2.2
6060
Status warning
6161
Is Development Yes
6262
Woo Extension My Extension

docs/using-qit/running-tests-dashboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ If you prefer a user interface (UI) over the command line, the WooCommerce Vendo
44

55
## Prerequisites
66

7-
- **Woocommerce.com partner developer account:** Ensure you are logged in with the vendor account associated with your extension.
7+
- **WooCommerce.com partner developer account:** Ensure you are logged in with the vendor account associated with your extension.
88
- **Extension listed on the WooCommerce marketplace:** The dashboard features are only available for extensions listed on WooCommerce.com.
99

1010
## Accessing the vendor dashboard

src/components/TestTypes.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export default function TestTypes({ includeCode = false }) {
2424
style={{ display: includeCode ? 'inline-block' : 'none' }}>run:malware</code></li>
2525
<li><a href="/docs/managed-tests/validation">Validation tests</a> <code
2626
style={{ display: includeCode ? 'inline-block' : 'none' }}>run:validation</code></li>
27-
<li><a href="/docs/managed-tests/plugin-check">wordpress.org Plugin Check tests</a> <code
27+
<li><a href="/docs/managed-tests/plugin-check">WordPress.org Plugin Check tests</a> <code
2828
style={{ display: includeCode ? 'inline-block' : 'none' }}>run:plugin-check</code></li>
2929
<li>Performance tests <i>(Coming soon)</i></li>
3030
</ul>

0 commit comments

Comments
 (0)