Documentation Grammar and Spelling Standardization

[Hopium21]

1. File: README.md
   Old: Branch: Always create a new branch for your changes. Naming it relevantly.
   New: Branch: Always create a new branch for your changes. Name it relevantly.
   Reason: Fixed to use proper imperative form in instructions. The imperative form is standard for command instructions and maintains consistency with other documentation guidelines.

2. File: how-to-guides/blobstream.md
   Old: developers to build high-throughput L2s using Celestia's optimised DA layer,
   New: developers to build high-throughput L2s using Celestia's optimized DA layer,
   Reason: Standardized to American English spelling. The project follows American English conventions throughout its documentation for consistency.

3. File: how-to-guides/systemd.md
   Old: description: Learn how to setup your node as a background process with SystemD.
   New: description: Learn how to set up your node as a background process with SystemD.
   Reason: Corrected the usage of "set up" (verb) versus "setup" (noun). When used as a verb phrase, it should be two words.

Summary by CodeRabbit

• Documentation
  • Updated contribution guidelines for clarity in the README.md.
  • Enhanced clarity and terminology in the blobstream.md, including expanded sections on functionalities and integration for developers.
  • Corrected phrasing in systemd.md to improve readability while maintaining existing instructions.

[coderabbitai]

Walkthrough

This pull request includes minor textual modifications across several documentation files. The README.md file features a grammatical correction in the contribution guidelines. The blobstream.md document has been enhanced for clarity, terminology, and expanded content related to Blobstream's functionalities and integration processes. Lastly, the systemd.md file corrects a phrasing error in the setup description for node configurations. Overall, the changes focus on improving the clarity and accuracy of the documentation.

Changes

File	Change Summary
README.md	Corrected "Naming it relevantly." to "Name it relevantly." for grammatical accuracy.
how-to-guides/blobstream.md	Changed "optimised" to "optimized"; expanded content on Blobstream functionalities and integration process.
how-to-guides/systemd.md	Corrected "setup" to "set up" in the description header; no other changes made.

Possibly related PRs

• [docs: add a blobstream X deployment section #1567] The changes in developers/blobstream.md involve adding a section on deploying Blobstream X, which is related to the minor textual modifications in the README.md regarding contribution guidelines, as both pertain to documentation improvements.
• [docs: adding BlobstreamX deployment docs  #1643] The updates in developers/blobstream-rollups.md and developers/blobstream-x-deploy.md focus on enhancing documentation for Blobstream X, which aligns with the changes made in the README.md for clarity and correctness in contribution guidelines.
• [docs: update blobstream to SP1 version from Blobstream X #1680] The modifications in developers/blobstream-x-deploy.md regarding deployment instructions for Blobstream X are related to the documentation improvements in the README.md, as both aim to enhance clarity for developers.
• [Update blobstream-proof-queries.md #1757] The updates in how-to-guides/blobstream-proof-queries.md regarding proof queries are relevant to the changes in README.md, as both involve improving documentation clarity and usability for developers.
• [Updated outdated link in blobstream-rollups.md #1761] The corrections made in how-to-guides/blobstream-rollups.md to update links and enhance clarity are related to the changes in README.md, as both aim to improve the documentation's accuracy and usability.
• [docs: update quickstart #1766] The updates in the quick start guide and the changes in README.md both focus on enhancing the clarity and organization of documentation for new users.
• [chore: Fix typos in documentation for multiple files #1780] The typo corrections across multiple files, including how-to-guides/docker-images.md, relate to the overall goal of improving documentation quality, similar to the changes made in README.md.
• [Typo Update foundation-delegation-program.md #1784] The grammatical corrections in community/foundation-delegation-program.md are relevant to the changes in README.md, as both aim to enhance clarity and readability in documentation.
• [Typo Update retrievability.md #1785] The updates in learn/retrievability.md regarding data retrievability practices are related to the changes in README.md, as both focus on improving the clarity and accuracy of documentation.
• [Fix Typographical and Inconsistency Errors in Documentation #1792] The typographical and inconsistency corrections in various documents, including how-to-guides/docker-images.md, relate to the changes in README.md, as both aim to enhance the overall quality of documentation.

Suggested labels

documentation

Suggested reviewers

• jcstein

🐇 In the land of code where the bunnies hop,
We fix the docs, and we never stop!
With words made clear and phrases bright,
Our guides will help you, day or night.
So read along, and you'll surely see,
How easy it is to code with glee! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cd6c8a7 and 8632d9d.

📒 Files selected for processing (3)

• README.md (1 hunks)
• how-to-guides/blobstream.md (1 hunks)
• how-to-guides/systemd.md (1 hunks)

✅ Files skipped from review due to trivial changes (2)

• README.md
• how-to-guides/systemd.md

🔇 Additional comments (1)

how-to-guides/blobstream.md (1)

16-16: LGTM! Spelling standardization to American English.

The change from "optimised" to "optimized" aligns with the PR objective of standardizing American English spelling conventions throughout the documentation.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[amodulardev]

I feel this is nitpicking more than a useful commit.

[jcstein]

agreed tbh.