SUGAM-ARORA / UniCollab

UniCollab is more than just a platform; it's a gateway to a world where students from different universities/colleges converge to collaborate, innovate, and elevate their projects. Imagine a space where ideas flow freely, where knowledge is shared effortlessly, and where learning transcends classrooms. That's UniCollab for you.
https://uni-collab.vercel.app/
MIT License
58 stars 111 forks source link

Add Table of Contents to README #275

Open GUNJESH843 opened 2 months ago

GUNJESH843 commented 2 months ago

Title: Add Table of Contents to README

Description: The README file of the UniCollab project lacks a table of contents, making it difficult for users to navigate through different sections of the document. To improve readability and usability, we should add a table of contents with anchor links to each section.

Expected Benefits:

Implementation Steps:

  1. Identify the major sections and subsections of the README file.
  2. Determine the appropriate formatting and styling for the table of contents.
  3. Add anchor links to each section and subsection.
  4. Test the table of contents to ensure that all links are working correctly.
  5. Update the README file with the new table of contents.

look afterwards: Screenshot 2024-06-11 140607

github-actions[bot] commented 2 months ago

Thank you for creating this issue! 🎉 @SUGAM-ARORA will look into it as soon as possible. In the meantime, please make sure to provide all the necessary details and context. If you have any questions or additional information, feel free to add them here. Your contributions are highly appreciated! 😊

You can also check our CONTRIBUTE.md for guidelines on contributing to this project.

GUNJESH843 commented 2 months ago

I would like to work on this.

GUNJESH843 commented 2 months ago

@SUGAM-ARORA , I have worked on the issue and have created a PR(Update README.md #276) please review it

SUGAM-ARORA commented 2 months ago

@GUNJESH843 Issue assigned to you