Skip to content

docs: Correct typos and grammatical errors in documentation and READMEs #205

Description

@ApurveKaranwal

Description

Problem

There are several minor typos, grammatical errors, and phrasing inconsistencies across the codebase's documentation files and READMEs. Fixing these will improve readability for new users and contributors.

Identified Issues

  1. README.md
    • "checkout" is used instead of "check out" for development instructions.
  2. packages/backend/README.md
    • "command line tool" lacks a hyphen (should be "command-line tool").
    • Incorrect spelling "Embedding Altas" instead of "Embedding Atlas".
    • Typos in projection documentation: "To visual embedding projections" instead of "To visualize embedding projections".
    • "Python Notebook" capitalized inconsistently compared to standard lowercase "Python notebook".
  3. packages/docs/embedding-view-mosaic.md & packages/docs/embedding-view.md
    • "a few millions of points" instead of "a few million points".
    • "wrappers of the component" instead of the more natural "wrappers for the component".
  4. packages/docs/overview.md
    • "command line tool" lacks a hyphen.
    • "from command line" is missing the definite article (should be "from the command line").
    • "components as API" should be pluralized as "components as APIs".

Proposed Solution

Update these files to correct the spelling, grammar, and phrasing. I have the changes ready and would be happy to submit a Pull Request to fix these!

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions