Skip to content

Fix typos, grammar, broken links and examples in the guides - #913

Open
W0rma wants to merge 5 commits into
Codeception:masterfrom
W0rma:fix-docs-typos
Open

W0rma wants to merge 5 commits into
Codeception:masterfrom
W0rma:fix-docs-typos

Conversation

@W0rma

@W0rma W0rma commented Nov 21, 2026

Copy link
Copy Markdown
Contributor

These changes only touch the hand-written guides in docs/*.md and the reference pages Configuration.md and ShellAutocomplete.md. Pages generated from source were not changed.

  • Typos: about 36 spelling mistakes and doubled words, plus wrong names such as PHPBrowser → PhpBrowser, USER_ARRAY → USERS_ARRAY and -use-vendor-bin → --use-vendor-bin.
  • Grammar: about 45 fixes, plus rewrites of a few garbled or unfinished sentences.
  • Broken links:
    • Links to the old numbered pages (e.g. 06-ModulesAndHelpers#Helpers), which only redirect and lose the anchor, now point to the current pages.
    • Links to anchors that no longer exist are fixed.
    • The blob/5.0 links to the Codeception repo, which return 404, now point to main.
    • Outdated PHPUnit, Selenium, GitLab, Guzzle and phpunit.de URLs are replaced. All new URLs were checked and return 200.
  • Broken YAML:
    • The SOAP module config was indented wrong.
    • The {{your site URL}} placeholder rendered as an empty value on the site.
    • "Step\Admin" in double quotes contained an invalid escape sequence.
    • A bare ... placeholder ended the YAML document early.
    • Shell commands were marked as YAML.
  • Broken code examples:
    • Missing AcceptanceTester imports and namespaces.
    • A missing semicolon, an unquoted XPath value and malformed XML.
    • The AspectMock assertion checked the wrong object.
    • gherkin:steps was missing its required suite argument.
    • The HTML merge read files that the example never writes.
    • Method names that didn't match the generator (testMe → testSomeFeature).
    • Shell commands were marked as php.

@W0rma
W0rma marked this pull request as ready for review November 21, 2026 12:44
@W0rma
W0rma requested review from Arhell and TavoNiievez November 21, 2026 12:44

This branch has not been deployed

No deployments
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.

1 participant