ipfs / kubo

An IPFS implementation in Go
https://docs.ipfs.tech/how-to/command-line-quick-start/
Other
16.18k stars 3.02k forks source link

Correct spelling and improve readability in documentation #10594

Open famouswizard opened 1 day ago

famouswizard commented 1 day ago

Description:

This pull request addresses a couple of spelling and readability issues in the documentation files.

Changes made:

  1. File: docs/add-code-flow.md

    • Change: "datastructures" → "data structures"
      Reason: The term "data structures" should be two words instead of a single word for better readability and consistency with common usage.
  2. File: docs/datastores.md

    • Change: "availble" → "available"
      Reason: Corrected the typo in the word "availble" to "available" in the section discussing the "pebbleds" datastore.

These changes are important because they improve the clarity and correctness of the documentation. While "datastructures" is not technically wrong, separating it into "data structures" is the more widely accepted form and improves readability. Similarly, the typo in "availble" could cause confusion and looks unprofessional, so it was corrected to "available" to maintain accuracy.

Impact: These corrections enhance the overall user experience by ensuring the documentation is clear, precise, and free from typographical errors.

Thank you for reviewing this update!