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 Table of Contents to README File #363

Open
3 tasks done
T-Fathima opened this issue Oct 19, 2024 · 0 comments
Open
3 tasks done

Add Table of Contents to README File #363

T-Fathima opened this issue Oct 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@T-Fathima
Copy link

T-Fathima commented Oct 19, 2024

Issue Description

The current README file lacks a Table of Contents, which makes it difficult for users to navigate through the document. Adding a Table of Contents will help improve accessibility and readability, especially for larger README files with multiple sections.

Screenshots or Examples (if applicable)

image

Proposed Solution (optional)

Suggested Solution:
Add a Table of Contents at the top of the README file that includes links to the following sections:
Introduction
Installation
Usage
Contribution Guidelines
License

Checklist

  • I have checked the existing issues.
  • The changes don't break the code.
  • Please attach the screenshots and video of the development work once it is done.

Additional Comments (optional)

@GarimaSingh0109 I would like to work on it.
Please assign it to me under gssoc-ext and hacktoberfest

@T-Fathima T-Fathima added the documentation Improvements or additions to documentation label Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant