Commit 6f3690f
Docs: Fix grammar, typos, and formatting issues across documentation (#2877)
### Summary
This PR addresses multiple grammar, typo, and formatting issues found
throughout the WordPress Playground documentation to improve readability
and consistency.
### Changes Made
#### Critical Fixes
1. **Incorrect backtick characters**
(`developers/07-xdebug/02-getting-started.md`)
- Fixed: `´.vscode/launch.json´` → `` `.vscode/launch.json` ``
- This was preventing proper code formatting in the rendered
documentation
#### Grammar Improvements
2. **Missing words and articles**
- "Now you connect a debugger" → "Now you **can** connect a debugger"
- "Here's a very example" → "Here's a very **simple** example"
3. **Sentence structure**
- "Suppose you're not familiar with the tool. In that case, we
recommend" → "If you're not familiar with the tool, we recommend"
- "prioritizing easy installation" → "prioritizing **ease of**
installation"
4. **Incorrect conjunctions**
- "the same than contributing" → "the same **as** contributing"
5. **Verb corrections**
- "Allow testers run branches" → "Allow**s** testers **to** run
branches"
- "report it using" → "report **them** using"
#### Formatting & Consistency
6. **Consistent file extension formatting**
- "Download as zip" → "Download as **.zip**"
- "Import from zip" → "Import from **.zip**"
7. **Parallel structure in lists**
- Changed "It creates a `.zip`" → "Creates a `.zip` file"
- Changed "It allows you to recreate" → "Allows you to recreate"
8. **Punctuation improvements**
- Added missing commas for better readability
- Fixed spacing around en dashes: "(you're here)–" → "(you're here) –"
9. **Capitalization**
- "gutenberg" → "Gutenberg" (proper noun)
10. **Workflow terminology**
- "on your developer flow" → "in your developer **workflow**"
### Files Changed (9 files)
- `packages/docs/site/docs/developers/07-xdebug/02-getting-started.md`
(3 fixes)
- `packages/docs/site/docs/developers/intro-devs.md` (1 fix)
- `packages/docs/site/docs/developers/06-apis/01-index.md` (1 fix)
- `packages/docs/site/docs/developers/05-local-development/intro.md` (1
fix)
-
`packages/docs/site/docs/developers/05-local-development/04-wp-playground-cli.md`
(1 fix)
- `packages/docs/site/docs/developers/05-local-development/01-wp-now.md`
(1 fix)
- `packages/docs/site/docs/main/contributing/documentation.md` (2 fixes)
- `packages/docs/site/docs/main/web-instance.md` (4 fixes)
- `packages/docs/site/docs/main/about/index.md` (1 fix)
### Testing
- [x] All changes verified for proper markdown rendering
- [x] Grammar and readability improvements confirmed
- [x] Consistency checks across similar sections
### Type of Change
- [x] Documentation update
- [x] Bug fix (typos and formatting errors)
### Related Issues
Fixes general documentation quality issues
---
### Checklist
- [x] Documentation follows the project's style guidelines
- [x] Changes improve clarity and readability
- [x] All affected files have been reviewed
- [x] No breaking changes to existing links or references
---------
Co-authored-by: Fellyph Cintra <fellyph.cintra@gmail.com>1 parent 9424405 commit 6f3690f
File tree
9 files changed
+16
-15
lines changed- packages/docs/site/docs
- developers
- 05-local-development
- 06-apis
- 07-xdebug
- main
- about
- contributing
9 files changed
+16
-15
lines changedLines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
85 | 85 | | |
86 | 86 | | |
87 | 87 | | |
88 | | - | |
| 88 | + | |
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
98 | | - | |
| 98 | + | |
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
| |||
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
121 | | - | |
| 121 | + | |
122 | 122 | | |
123 | 123 | | |
124 | 124 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
58 | | - | |
59 | | - | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | | - | |
70 | | - | |
| 69 | + | |
| 70 | + | |
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
| |||
0 commit comments