Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADD INTRODUCTION AND OVERVIEW ALONG WITH TABLE OF CONTENT #951

Closed
wants to merge 17 commits into from

Conversation

alo7lika
Copy link
Contributor

Pull Request for DL-Simplified 💡

Issue Title : ADD INTRODUCTION AND OVERVIEW ALONG WITH TABLE OF CONTENT

  • Info about the related issue (Aim of the project) : The goal of this project is to introduce the repository and provide a clear overview of the content, including a well-structured Table of Contents to facilitate navigation.
  • Name: Alolika bhowmik
  • GitHub ID: alo7lika
  • Email ID: [email protected]
  • Identify yourself: GSSoC 2024 Extended Contributor

Closes: #931

Describe the add-ons or changes you've made 📃

I have added a detailed introduction to the repository, including key information about the purpose of Deep Learning Simplified. I also created a comprehensive Table of Contents for easy navigation, covering all major sections of the project README.

Type of change ☑️

What sort of change have you made:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, local variables)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested? ⚙️

The changes have been verified by:

  1. Reviewing the newly added content for clarity and relevance.
  2. Ensuring that the Table of Contents links correctly to all the sections.
  3. Checking the consistency of formatting with the existing project style.

Checklist: ☑️

  • My code follows the guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly wherever it was hard to understand.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added things that prove my fix is effective or that my feature works.
  • Any dependent changes have been merged and published in downstream modules.

Screenshot 2024-10-25 172018

Copy link

Our team will soon review your PR. Thanks @alo7lika :)

@alo7lika
Copy link
Contributor Author

@abhisheks008 the task has been completed.

Copy link
Owner

@abhisheks008 abhisheks008 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create a separate pull request for this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ADD INTRODUCTION AND OVERVIEW ALONG WITH TABLE OF CONTENT
2 participants