[Docs] Improve Docs with the problem statement

[niloysikdar]

Description:

• We need to describe the problem we're solving and also the solution on how our package is solving that particular problem.

Outcome:

• Detailed writeup about the problem and the approach for the solution in the README.md file.

[Logan-kwan]

hi! if you could give me more information on the specific problems and solutions mentioned, I would love to work on this!

[niloysikdar]

Hi @Logan-kwan , thanks for showing interest to work on this issue. You can watch this video to get complete info about the package.

Do let me know if you have any queries.

Also, make sure to drop a star on the repo to support the project and open-source🌟😇

[Logan-kwan]

just a quick question: do you have a preference on where to put the problem and suggested solution?

[niloysikdar]

Hmmm, I think it will be best to put it at the very start of the README after the name and description of the package.

[Anurag2293]

Hey @niloysikdar, would just like to ask if any help is further required for this issue.
Would like to contribute to it?

[niloysikdar]

Sure @Anurag2293

[Anurag2293]

Can you guide me on how to get started?
I am a complete beginner in open source, though I am well versed in Git & GitHub.
Do I need to clone this project in my local device for the documentation part as well ?

[niloysikdar]

Yes @Anurag2293, first you need to create a fork of the repo and then clone it into your local machine.

Then go the the /docusaurus folder and enter yarn command to install the dependencies for the docs. After installing the dependencies, run yarn start to start the development server for docusaurus. Go to localhost:3000 and you'll be able to see the docusaurus site up and running.

Do let me know if you have any queries or need any help. Don't forget to join the gitter channel for the discussions.

Also, make sure to drop a star on the repo to support the project and open-source🌟😇

[Anurag2293]

Hey @niloysikdar so I am done with the setup and docusaurus app running on my local device.
I would like to ask about any good first issues which I can work on.

p.s. I am very new to open source. kindly bear with me 😅

[niloysikdar]

Awesome @Anurag2293, you can explore the Beginner Friendly issues here

Do let me know if you need any more help.

[Anurag2293]

Hey @niloysikdar, after going through the first issues, I think I need to learn typescript for react (currently using plain JS only).
I will get back to you after learning React with TS in 1-2 days.

[niloysikdar]

Yes, you need to have the idea of TypeScrpt.
Go ahead, all the best.