Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and improve clarity in documentation #45

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

Miska05
Copy link

@Miska05 Miska05 commented Dec 25, 2024

Overview

This pull request fixes typographical errors and improves clarity across 13 design documents in the repository. The changes aim to enhance the readability and professionalism of the documentation.

Summary of Changes

  • Corrected spelling and grammatical errors in the following files:
    • 0005-proving-queue.md
    • 0004-world-state.md
    • 0003-native-merkle-trees.md
    • 5040-native-merkle-trees-napi.md
    • 7025-instrumenting-the-node-with-open-telemetry.md
    • 7346-batch-proving-circuits-and-l1.md
    • 7482-sequencer-prover-test-net.md
    • 7520-testnet-overview.md
    • 7588-spartan-clusters.md
    • 8131-forced-inclusion.md
    • 8404-based-fallback.md
    • README.md

Impact

These changes:

  • Do not affect code functionality or APIs.
  • Improve documentation quality for easier comprehension by developers and stakeholders.

Please review the changes and let me know if there are any additional improvements needed.🚀

Corrected multiple typos in the documentation, including:
- 'inovked' → 'invoked'
- 'seperation' → 'separation'
- 'acknowldgement' → 'acknowledgment'
- 'Proof Reault' → 'Proof Result'
- 'optimsation' → 'optimization'

These changes improve readability and ensure accuracy in the document.
Corrected several typos and inconsistencies, including:
- 'uncommmitted' → 'uncommitted'
- 'retrievel' → 'retrieval'
- 'seperated' → 'separated'
- 'priuning' → 'pruning'
- 'effecitvely' → 'effectively'
- 'benficial' → 'beneficial'

These changes ensure better readability and maintain professionalism in the documentation.
Corrected several typos and improved the documentation for better readability and accuracy:
- 'cuirrent' → 'current'
- 'synched' → 'synced'
- 'individiually' → 'individually'
- 'absrtacted' → 'abstracted'
- 'whan' → 'when'
- 'signifcant' → 'significant'
- 'identiying' → 'identifying'
- 'inidividually' → 'individually'
- 'dicarded' → 'discarded'
- 'preceeding' → 'preceding'
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