Skip to content

Title: Add Table of Contents to README for easier navigation #350

@durdana3105

Description

@durdana3105

🔍 Have You Searched Existing Issues?

  • I have searched the existing issues to avoid duplicates

📝 What's wrong with the existing documentation?

Description:
The current README is very detailed and contains multiple sections, including Overview, Vision, Key Features, Technologies Used, Installation, Troubleshooting, Contribution Guidelines, License, and more. However, it lacks a Table of Contents, which makes it harder for users and contributors to quickly navigate to specific sections.

Proposed Solution:
Add a Table of Contents at the top of the README.
Make it clickable, linking to all major sections such as:

Overview
Vision
Why SaralSeva
Mission
Live Demo
Key Features (Citizen, Employee, Admin)
Technologies Used
Installation and Setup
Troubleshooting
Contribution Guidelines
Code of Conduct
License
Stargazers & Forkers

Benefit:
Improves readability and user experience.
Helps new contributors quickly find relevant information.

Label Suggestion: enhancement, documentation, GSSoC, wocs

Assign to me, i'll work on it

📎 Supporting Material

No response

🙌 Contributor Checklist

  • I have reviewed the existing documentation
  • I agree to follow this project's Code of Conduct
  • I am a GSSOC'25 contributor
  • I want to work on this issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions