open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership

Home Page:https://opensauced.pizza/learn

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bug: Duplication of the term "Docs" in the Glossary

adiati98 opened this issue · comments

Describe the bug

Important

If you've worked on a "beginner only" issue or "good first issue" in any of our community repositories before, please refrain from taking this issue.
We may remove you from the assignees and not accept your pull request if you choose to proceed.

Description

There is a duplication of the term "Docs" in our Glossary. Another thing, the example that's given here is not quite accurate.

Suggested Solution

In the 10-glossary.md file:

  • Delete the duplication (line 45-48).

    ## Docs
    This is an abbreviation for the word documentation, a piece of text that provides information on how to contribute to OSS projects and expectations for contributors. Markdown, a text-based coding language is often used to create these forms of content. Want to see one in action? Check out the [Style Guide in our Pizza Verse repo](https://github.com/open-sauced/pizza-verse/blob/main/style-guide.md)!

  • Update the wording in line 23.

    Docs is an abbreviation for "documentation". It primarily explains how to implement and use a product or an open source project. It also provides information on how to contribute to the project and expectations for contributors. Documentation is often written using [Markdown](https://www.markdownguide.org/), a lightweight markup language.

    Line to be updated:

    This is an abbreviation for the word documentation. Its primary use is to explain how to implement and use the product. Documentation also provides people with information on how to contribute to OSS projects and expectations for contributors. Markdown, a text-based coding language is often used to create these forms of content. Want to see one in action? Check out the [Style Guide in our Pizza Verse repo](https://github.com/open-sauced/pizza-verse/blob/main/style-guide.md)!

Steps to reproduce

  1. Go to https://intro.opensauced.pizza/#/intro-to-oss/glossary
  2. You will see the duplication of the term "Docs".

Do you have any images or screen captures?

No response

Browsers

Chrome

Additional context (Is this in dev or production?)

No response

Code of Conduct

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

Contributing Docs

  • I agree to follow this project's Contribution Docs

may I proceed with this issue?

@RishabhDhawad it's all yours!
Please let us know if you need any help. Thanks 😊

Hello Adiati, This time I have created my branch named "rishabh" and tried to raise a PR following the contributing guidelines. If there are still points where I am lacking, do let me know.