Skip to content

Conversation

@hmbashar
Copy link
Contributor

@hmbashar hmbashar commented Nov 7, 2025

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

  1. 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"
  2. 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"
  3. Incorrect conjunctions

    • "the same than contributing" → "the same as contributing"
  4. Verb corrections

    • "Allow testers run branches" → "Allows testers to run branches"
    • "report it using" → "report them using"

Formatting & Consistency

  1. Consistent file extension formatting

    • "Download as zip" → "Download as .zip"
    • "Import from zip" → "Import from .zip"
  2. Parallel structure in lists

    • Changed "It creates a .zip" → "Creates a .zip file"
    • Changed "It allows you to recreate" → "Allows you to recreate"
  3. Punctuation improvements

    • Added missing commas for better readability
    • Fixed spacing around en dashes: "(you're here)–" → "(you're here) –"
  4. Capitalization

    • "gutenberg" → "Gutenberg" (proper noun)
  5. 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

  • All changes verified for proper markdown rendering
  • Grammar and readability improvements confirmed
  • Consistency checks across similar sections

Type of Change

  • Documentation update
  • Bug fix (typos and formatting errors)

Related Issues

Fixes general documentation quality issues


Checklist

  • Documentation follows the project's style guidelines
  • Changes improve clarity and readability
  • All affected files have been reviewed
  • No breaking changes to existing links or references

- Fix incorrect backtick characters (´ to `) in xdebug getting-started guide
- Improve sentence structure and grammar throughout multiple docs
- Add missing articles, conjunctions, and proper punctuation
- Standardize formatting for file extensions (.zip consistency)
- Fix spacing issues with en dashes
- Correct verb tenses and parallel structure in lists
- Improve clarity and readability across all affected pages
Affected files:
- developers/07-xdebug/02-getting-started.md
- developers/intro-devs.md
- developers/06-apis/01-index.md
- developers/05-local-development/intro.md
- developers/05-local-development/04-wp-playground-cli.md
- developers/05-local-development/01-wp-now.md
- main/contributing/documentation.md
- main/web-instance.md
- main/about/index.md
Copy link
Collaborator

@fellyph fellyph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @hmbashar

@fellyph fellyph merged commit 6f3690f into WordPress:trunk Nov 7, 2025
25 checks passed
@hmbashar hmbashar deleted the docs/fix-grammar-and-formatting-issues branch November 7, 2025 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants