Skip to content

Documentation: Fixing grammar and spelling errors in README.md #3731

@Bittukumar1j

Description

@Bittukumar1j

Please verify the following:

URL to the MDwiki page containing the problem

https://github.com/open-learning-exchange/open-learning-exchange.github.io/blob/master/README.md

Problem

Description of the Problem

While following the 10 steps introductory guide, I noticed minor grammatical and spelling errors in the project's main README.md file.

Specific Issues Found:

  • Spelling Error: The word loose is used instead of lose in the 'Create a New Wiki' section.
  • Grammar Inconsistency: In the 'Multiple Wikis' section, the phrasing "In case would you like to" should be "In case you would like to".
  • Readability: Some auxiliary verbs are missing in the CLI instructions, which might be confusing for new interns.

This issue is being filed as part of Step 6 to practice the GitHub workflow and improve project documentation.

Screenshots (when necessary)

No response

Proposed solution(s)

Suggested Fixes:

  1. Edit the README.md to correct the spelling of lose.
  2. Adjust the sentence structure in the 'Multiple Wikis' section for better flow.
  3. Standardize the formatting of the CLI commands to ensure they are easy to follow.

I will submit a Pull Request (PR) shortly to resolve these minor issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    mifirst steps - mobile virtual internsvalid

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions