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

Corrected grammar, punctuation, and formatting inconsistencies. #527

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

Conversation

gap-editor
Copy link

Description

  • Standardized terminology, including corrections to "Github" → "GitHub" and "amongst" → "among."
  • Improved sentence structure for clarity and conciseness (e.g., "double issues" → "duplicate issues").
  • Fixed minor grammatical errors, such as possessive forms and missing prepositions.
  • Enhanced the readability of walkthrough and conceptual sections.
  • Improved consistency in formatting, especially in numbered lists and code blocks.
  • Addressed minor typographical errors across multiple documentation files.

**Extended Description:**  
- Removed redundant wording for better readability.  
- Corrected inconsistency in the walkthrough structure section (adjusted section count).  
- Simplified phrasing in the acronym explanation for improved clarity.  
- General formatting improvements for consistency in documentation.  


Signed-off-by: Maximilian Hubert <[email protected]>
### Extended Description:  
- Fixed minor typos (e.g., "definiition" → "definition").  
- Ensured consistency in terminology (e.g., "ETH1 address" usage).  
- Improved formatting in JSON examples for readability.  
- Clarified phrasing in some sentences to enhance comprehension.  
- Standardized table formatting for better visibility of key information.  


Signed-off-by: Maximilian Hubert <[email protected]>
Signed-off-by: Maximilian Hubert <[email protected]>
**Extended description:**  
- Refined sentence structures for better readability and conciseness.  
- Corrected minor grammatical inconsistencies and improved flow.  
- Enhanced clarity in key sections, including DVT benefits, Ethereum roadmap positioning, and validator performance testing.  
- Suggested additional context for correlation minimization and performance testing results.


Signed-off-by: Maximilian Hubert <[email protected]>
## Extended description
- Improved sentence structure for better readability.
- Corrected grammatical errors, including missing apostrophes and incorrect prepositions.
- Enhanced clarity in technical descriptions.
- Ensured consistency in terminology (e.g., "public goods" to "core components").
- Refined phrasing for better fluency and professional tone.


Signed-off-by: Maximilian Hubert <[email protected]>
## Extended description
- Corrected grammatical errors and improved sentence structure.
- Clarified technical terms for better precision (e.g., "relay service" instead of "relayer").
- Reworded informal or ambiguous phrases for better readability.
- Standardized terminology for consistency (e.g., "execution clients generate execution payloads").
- Ensured a smoother flow in key explanations, particularly for Distributed Key Generation (DKG).


Signed-off-by: Maximilian Hubert <[email protected]>
Signed-off-by: Maximilian Hubert <[email protected]>
Signed-off-by: Maximilian Hubert <[email protected]>
Signed-off-by: Maximilian Hubert <[email protected]>
Signed-off-by: Maximilian Hubert <[email protected]>
Signed-off-by: Maximilian Hubert <[email protected]>
Copy link

netlify bot commented Feb 2, 2025

Deploy Preview for obol-docs ready!

Name Link
🔨 Latest commit 4ac872d
🔍 Latest deploy log https://app.netlify.com/sites/obol-docs/deploys/679f7bc652346500088be995
😎 Deploy Preview https://deploy-preview-527--obol-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Attempted to resolve the issue described in ObolNetwork#526 by fixing the Docs Version and Locale Dropdown functionality.


Signed-off-by: Maximilian Hubert <[email protected]>
Copy link

sonarqubecloud bot commented Feb 2, 2025

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