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 "Back to top" links to each section in README.md #626

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

rviquezs
Copy link

@rviquezs rviquezs commented Sep 10, 2024

Description

I have added "Back to top" links beneath each h2 and h3 header in the README.md file to enhance navigation. These links allow users to quickly return to the "Table of Contents" section without needing to scroll manually.

Demo

Motivation and Context

This change improves user experience by making it easier to navigate through the document. The addition of "Back to top" links is especially helpful for longer sections, saving users time and effort when reviewing content.

How Has This Been Tested?

  1. Clicking each "Back to top" link to ensure they navigate back to the "Table of Contents" section.
  2. Ensured that links are displayed correctly across different Markdown viewers (GitHub, local Markdown viewers, etc.).
  3. Reviewed the Markdown file to confirm that no other content was affected.

Types of changes

  • Content Update (change which fixes an issue or updates an already existing submission)
  • New Article (change which adds functionality)
  • Documentation change

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have made checks to ensure URLs and other resources are valid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant