Need a descriptive detail about the project

[speco29]

As a beginner, the project does not give a clear view about the project. We need a good a descriptive detail to work on the project.

[Vedarghya05]

Hi, I would like to work on this issue. Could you please assign it to me?

[speco29]

hello @Vedarghya05
I'm just a contributor here, you can resolve this issue by giving a pull request.

[Udayscode]

Hi @speco29 ,
Thanks for raising this issue! Could you clarify what specific details you're looking for? For instance:

• Are you looking for an overview of the project?
• Do you need technical details or setup instructions?
• Is there a specific part of the project you'd like more information about?

This will help us address your feedback more effectively. Thank you!

[speco29]

hello @Udayscode
The overview of the project isn't clear enough to get in depth of the project.
you can add a good overview of like what this project is and how it aims to solve something.
For example it says "This project aims to visualize the intersection of open source software and scientific research." in its overview doc but by simply reading it, it does not give idea of the project very well.

[jring-o]

I'll be updating the readme with more details and docs in the coming weeks. Thanks for bringing this up!

[samuel-schwartz]

@jring-o , I added more information to the readme in my pull request (#21 ). Close this issue and if people still think more is needed they can open a new issue?

[jring-o]

Thanks for the pings and contributions, @samuel-schwartz! I've reviewed your proposed readme.

A few thoughts

• We still need to refine your large PR -- it might be worth breaking that into several smaller PRs. We can explore this on the prod call.
• We are not settled on the "Harvest, Bottle, Mix" for the "business logic". We will need to discuss this as a group. As a point, we have been discussing this similar process since the beginning of the project a couple years ago, just calling it something else = ).
• There are a couple other minor points that might not have been communicated well enough from Mark and myself on the calls.

It probably makes the most sense for @eyermt and I to continue working on the root readme which accepts modifications afterwards.

[SaniaSinha]

Hello, I would like to work on this issue, i am little late but i am interest to work, show my skills and learn new things. i would be really grateful if you could assign it to me. Thank you!!!

[jring-o]

Closing based on pr #30