Skip to content

Improved Readme by adding Table of Contents and Contributors section with contrib.rocks badge#716

Merged
utksh1 merged 2 commits into
utksh1:mainfrom
Yogender-verma:toc
Jun 9, 2026
Merged

Improved Readme by adding Table of Contents and Contributors section with contrib.rocks badge#716
utksh1 merged 2 commits into
utksh1:mainfrom
Yogender-verma:toc

Conversation

@Yogender-verma

Copy link
Copy Markdown
Contributor

Description

This PR improves the README documentation by adding a Table of Contents (TOC) and a Contributors section.

Changes Made

  • Added a Table of Contents (TOC) to improve navigation across the README.
  • Added a Contributors section using the contrib.rocks badge to showcase project contributors.
  • Updated the TOC to include a link to the Contributors section.
  • Improved overall structure, readability, and contributor visibility of the documentation.

Related Issues

Closes #713

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Verified README renders correctly on GitHub.
  • Confirmed TOC links navigate properly to all sections, including Contributors.
  • Checked that contrib.rocks badge loads and links to the contributors graph page.

Checklist

  • My code follows the code style of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.

@utksh1 utksh1 added level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label area:docs Documentation or contributor guide work gssoc:approved Admin validation: approved for GSSoC scoring labels Jun 9, 2026

@utksh1 utksh1 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Reviewed. README TOC/contributors update is docs-only and low risk.

@utksh1 utksh1 merged commit c3b2b93 into utksh1:main Jun 9, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation or contributor guide work gssoc:approved Admin validation: approved for GSSoC scoring level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Readme by adding Table of Contents and Contributors section with contrib.rocks badge

2 participants