Amna-Hassan04 / Serenity-Guide

SereniFi Guide is a personalized relaxation app offering meditations, breathing exercises, and calming music to help users achieve mental tranquility.
https://serenify.streamlit.app/
Other
33 stars 90 forks source link

[FEATURE] - Organizing DOCUMENTATION.md #144

Open khushidadwal opened 1 month ago

khushidadwal commented 1 month ago

Feature Title

Improvement in the DOCUMENTATION.md file

Problem Statement

In the current DOCUMENTATION.md file the points which should be in bullets are written in paragraphs. This makes it hard to understand and read it. Also, gives a very unorganized sight of the project.

image

Proposed Solution

I would like to format the file and make it look organised so it would be easier to understand. I will add bullet points and will also add description about few more python libraries. Please assign this task to me. Thanks :-)

Alternatives Considered

No response

Additional Context

No response

github-actions[bot] commented 1 month ago

👋 Thank you! Welcome to the project! Please follow these guidelines for smooth collaboration:

  1. After completing a task, add your name and details to the Contributors Table/List.
  2. Attach relevant screenshots or videos of your contribution for transparency.
  3. Tasks are assigned on a first-come, first-served basis.
    • Avoid spamming requests for already-assigned tasks.
    • Respect the queue and wait for new tasks.
  4. Propose New Ideas: Discuss new features or suggestions in the "Ideas" channel before starting work.
RounitSrivastava commented 1 month ago

I want to work on this task

Amna-Hassan04 commented 1 month ago

@khushidadwal first you will have to calculate if this repo hasnt surpassed its 150 points for documentation related tasks. if it hasnt then u can work on this, gssoc has a rule that this repo cannot give more than 150 points for documentation related tasks.