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 #953

Merged
merged 2 commits into from
Oct 26, 2024

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 aim is to enhance the README file and make it visually appealing and well-documented using the provided README template.
  • Name: Alolika Bhowmik
  • GitHub ID: https://github.com/alo7lika
  • Email ID: [email protected]
  • Identify yourself: GSSoC Contributor Ext 24

Closes: #931


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

I have updated the README file to include:

  1. An Introduction to the project to give users a clear understanding of DL-Simplified.
  2. An Overview section that highlights the project’s main goals and structure.
  3. A Table of Contents for easy navigation within the README file.

These changes make the documentation more comprehensive and user-friendly.


Type of change ☑️

Please select the type of change you have 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 were tested by:

  • Reviewing the updated README in the GitHub preview to ensure proper formatting.
  • Checking all links in the Table of Contents for correct navigation.
  • Verifying that all added sections align with the template and maintain readability.

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 where it was hard to understand.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added necessary elements that prove my fix is effective or that my feature works.
  • Any dependent changes have been merged and published in downstream modules.

Copy link

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

@alo7lika
Copy link
Contributor Author

@abhisheks008 kindly check the PR

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.

Project repository name should be aligned as Center.
@alo7lika

@alo7lika
Copy link
Contributor Author

Project repository name should be aligned as Center. @alo7lika

Done @abhisheks008

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.

Approved! @alo7lika

@abhisheks008 abhisheks008 added Status: Approved Approved PR by the PA. level 1 Level 1 for GSSOC hacktoberfest-accepted hacktoberfest and removed Status: Requested Changes Changes requested. labels Oct 26, 2024
@abhisheks008 abhisheks008 merged commit 2d60759 into abhisheks008:main Oct 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ADD INTRODUCTION AND OVERVIEW ALONG WITH TABLE OF CONTENT
2 participants