Skip to content

Docs: Fix typos and improve documentation #45

Open
@skytin1004

Description

Describe the issue or improvement

We have identified some typos and areas for improvement in our project documentation. This issue is perfect for first-time contributors who want to get started by improving the quality of our documentation.

Suggested changes

Task:

  1. Correct the following typos and grammatical errors in the README.md, CONTRIBUTING.md, and Co-op Translator Installation Guide:

    • "intial" -> "initial"
    • Fix capitalization errors (make sure all sentences start with a capital letter).
  2. Improve the Installation Guide section:

    • Provide more detailed steps for setting up the project, especially for beginners.
  3. Update the Contributing Guide:

    • Add additional information on how contributors can get started, including helpful links to external resources if applicable.

Feel free to ask any questions if you're unsure about something. We’re here to help!

Instructions:

  • Fork the repository.
  • Make the necessary changes in the relevant documentation files.
  • Submit a pull request (PR) referencing this issue.

Resources:

Are you willing to submit a pull request to improve the documentation?

  • I am willing to submit a pull request

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions