ADD INTRODUCTION AND OVERVIEW ALONG WITH TABLE OF CONTENT

alo7lika commented 6 days ago

Deep Learning Simplified Repository (Proposing new issue)

:red_circle: Project Title : ADD INTRODUCTION AND OVERVIEW ALONG WITH TABLE OF CONTENT
:red_circle: Aim : The aim is to enhance the README file and make it eye-pleasing and well documented using the given README template.
:red_circle: README to be enhanced :
:red_circle: README Template : README Template

:red_circle::yellow_circle: Points to Note :

The issues will be assigned on a first-come, first-served basis, 1 Issue == 1 PR.
"Issue Title" and "PR Title should be the same. Include issue number along with it.
Follow Contributing Guidelines & Code of Conduct before starting to contribute.

:white_check_mark: To be Mentioned while taking the issue :

Full name : Alolika Bhowmik
GitHub Profile Link : https://github.com/alo7lika
Email ID : [Your Email Here] alolikabhowmik72@gmail.com
Participant ID (if applicable): [Your Participant ID Here]
Approach for this Project : I plan to enhance the README file by adding an introduction, overview, and a well-structured table of contents to improve navigation and user experience.
What is your participant role? (Mention the Open Source program) : [Your Role Here]

Happy Contributing 🚀

All the best. Enjoy your open-source journey ahead. 😎

github-actions[bot] commented 6 days ago

Thank you for creating this issue! We'll look into it as soon as possible. Your contributions are highly appreciated! 😊

alo7lika commented 6 days ago

ADD LABELS GSSOC EXT 24 AND HACKTOBERFEST. ASSIGN ME THE TASK THANK YOU @abhisheks008 !

abhisheks008 commented 5 days ago

What are changes you want to do in the existing README template? Can you please clarify on this. It seems good to me tbh.

alo7lika commented 5 days ago

What are changes you want to do in the existing README template? Can you please clarify on this. It seems good to me tbh.

I will enhance the README file by adding the following elements for a clear understanding and audience engagement:

[x] Table of Contents: I will create a detailed and well-structured table of contents to help users easily navigate the README file, ensuring a smooth flow from introduction to usage and contribution guideline
[x] Overview: I’ll provide a concise and informative overview of the project, summarizing its core functionalities and goals to give users a clear picture of what the project is about.
[x] Hacktoberfest and GSSoC Banner: To increase visibility and participation, I will add banners for Hacktoberfest and GirlScript Summer of Code (GSSoC). This will attract contributors by showing that the project is open to community collaboration, especially for those participating in these events.
[x] Enhanced Introduction: I will craft an attractive and engaging introduction, highlighting the project's key features and goals in a clear, compelling manner. The introduction will not only explain the project but also draw the audience in with its well-structured and appealing language.

abhisheks008 commented 5 days ago

The README.md template you have tagged is not required this kind of implementations. If you are planning to change the README.md template, for your information this is used in the project folders, I don't think it's feasible to update each and every project folder's README like this.

I am not getting your points on the README updation. Please clarify which README is going to be updated. I'd recommend you to go through the project folders to get an idea about the README files of each and every project folder.

If you are planning to implement any changes in the repository's README file then the mentioned link is not correct, it's https://github.com/abhisheks008/DL-Simplified/blob/main/README.md

alo7lika commented 5 days ago

The README.md template you have tagged is not required this kind of implementations. If you are planning to change the README.md template, for your information this is used in the project folders, I don't think it's feasible to update each and every project folder's README like this.

I am not getting your points on the README updation. Please clarify which README is going to be updated. I'd recommend you to go through the project folders to get an idea about the README files of each and every project folder.

If you are planning to implement any changes in the repository's README file then the mentioned link is not correct, it's https://github.com/abhisheks008/DL-Simplified/blob/main/README.md

Sorry for the Inconvenience, yes I was talking about the Repo's README. I have updated the link as well. Thank you!

abhisheks008 commented 1 day ago

You can go ahead. Quick reminder: This kind of issue will get the label of Level 1 only.

abhisheks008 / DL-Simplified

ADD INTRODUCTION AND OVERVIEW ALONG WITH TABLE OF CONTENT #931

Deep Learning Simplified Repository (Proposing new issue)