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

[DOCS] Update README for navigable table of contents #700

Closed
3 tasks done
Pallavi-Mukalla opened this issue Oct 28, 2024 · 9 comments
Closed
3 tasks done

[DOCS] Update README for navigable table of contents #700

Pallavi-Mukalla opened this issue Oct 28, 2024 · 9 comments

Comments

@Pallavi-Mukalla
Copy link

Issue Description

The current README file lacks a navigable table of contents, making it difficult for users to quickly locate specific sections and information.
Without a table of contents, users must scroll through the entire README to find relevant sections, which can be time-consuming.

Screenshots or Examples (if applicable)

No response

Proposed Solution (optional)

I would like to enhance the README file by adding a navigable Table of Contents that links to specific sections. This will improve user experience by allowing easy access to different parts of the documentation. Ensure that all relevant headings have corresponding links in the Table of Contents.

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
Copy link

Congratulations, @Pallavi-Mukalla! 🎉 Thank you for creating your issue. Your contribution is greatly appreciated and we look forward to working with you to resolve the issue. Keep up the great work!

We will promptly review your changes and offer feedback. Keep up the excellent work! Kindly remember to check our contributing guidelines

@Pallavi-Mukalla
Copy link
Author

@swaraj-das please assign me this issue

Copy link

Hi there! This issue is still open. We are looking forward to your response.
Assignees: None

1 similar comment
Copy link

Hi there! This issue is still open. We are looking forward to your response.
Assignees: None

@Pallavi-Mukalla
Copy link
Author

@swaraj-das please assign me this issue

Copy link

Hi there! This issue is still open. We are looking forward to your response.
Assignees: @Pallavi-Mukalla

@Pallavi-Mukalla Pallavi-Mukalla mentioned this issue Oct 31, 2024
6 tasks
Copy link

github-actions bot commented Nov 1, 2024

Hi there! This issue is still open. We are looking forward to your response.
Assignees: @Pallavi-Mukalla

Copy link

github-actions bot commented Nov 9, 2024

This PR has been marked as stale due to 7 days of inactivity.

@github-actions github-actions bot added the Stale label Nov 9, 2024
Copy link

Closing this PR due to prolonged inactivity. Please reopen if necessary.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant