documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Corrected grammatical and terminology issues in documentation

Open 0xbryer opened this issue 1 year ago • 1 comments
trafficstars

Description:

This pull request addresses two issues found in the documentation files:

  1. File: website/docs/advanced/proof-of-stake-devnet.md

    • Issue: The sentence "Today, running an Ethereum node require two components:" contains a grammatical error. The word "require" should be changed to "requires" to agree with the singular subject "node."
    • Fix: The sentence is now correctly written as:

      "Today, running an Ethereum node requires two components:"

    • Importance: This fix ensures that the sentence is grammatically correct, improving readability and professionalism in the documentation.
  2. File: website/docs/advanced/switch-clients.md

    • Issue: The phrase "port forwards" is used incorrectly in the sentence: "Remove those two rules and replace them with the appropriate port forwards for the client you are switching to." The term "port forwards" should be changed to "port forwarding," as it refers to the process rather than a plural noun.
    • Fix: The corrected sentence reads:

      "Remove those two rules and replace them with the appropriate port forwarding for the client you are switching to."

    • Importance: This adjustment ensures that the terminology is accurate, helping users understand the intended action clearly and avoid confusion.

Both changes contribute to a more polished and precise documentation experience for developers and users.

0xbryer avatar Nov 17 '24 09:11 0xbryer