o1-labs / docs2

Docs website for the Mina Protocol.
https://docs.minaprotocol.com
93 stars 136 forks source link

Fix typos and incorrect punctuation in multiple documentation files #1076

Open defitricks opened 4 days ago

defitricks commented 4 days ago

This pull request addresses several minor but important issues in the documentation. The following errors have been fixed:

  1. docs/exchange-operators/faq.mdx
    The closing bracket for the Mina Protocol link was incorrectly placed before the word "MinaProtocol." This caused the link to not render correctly.
    Before: [Mina Protocol]](https://x.com/MinaProtocol) X (Twitter)
    After: Mina Protocol X (Twitter)
    This fix ensures that the link to Mina Protocol works as intended and improves the clarity of the text.

  2. docs/exchange-operators/index.mdx
    The word "preferrable" contained an extra "r," which is a common spelling error.
    Before: preferrable
    After: preferable
    Correcting this typo enhances the professionalism and accuracy of the documentation.

  3. docs/mina-protocol/block-producers.mdx
    In the "Select a block producer" section, the phrase "ta short-range fork" had a typo.
    Before: ta short-range fork
    After: a short-range fork
    This correction improves readability and ensures the phrase is grammatically correct.

  4. docs/mina-protocol/index.mdx
    In the "Node Operators" section, the phrase "describes how to run Mina nodes on a Mina network" was incorrect, as the subject should be plural.
    Before: describes how to run Mina nodes on a Mina network
    After: describe how to run Mina nodes on a Mina network
    This fix ensures subject-verb agreement and clarity.

  5. docs/mina-protocol/lifecycle-of-a-payment.mdx
    In the "Step 2" section, the word "choses" was used incorrectly.
    Before: chose
    After: chooses
    This correction ensures the sentence is in the correct tense and improves accuracy.

These changes may seem small, but they ensure the documentation is accurate, professional, and easy to understand for all users.

vercel[bot] commented 4 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 19, 2024 0:55am
vercel[bot] commented 4 days ago

@defitricks is attempting to deploy a commit to the o1labs Team on Vercel.

A member of the Team first needs to authorize it.