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

Fix readme link #2192

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

htoyoda18
Copy link

Update Duplicate Section Anchors in README

Overview

This PR aims to improve navigation within the README document by updating the anchor links for duplicate section titles. Specifically, it addresses the issue where multiple sections titled yup have been assigned identical anchor links, making it difficult to link to them individually.

Changes Made

  • Updated the anchor link for the second occurrence of the yup section to ensure it is unique and navigable. The original link #yup remains unchanged for the first section, while the second section's link has been updated to #yup-1.

Reasoning

In Markdown documents, especially in GitHub-flavored Markdown, duplicate headings result in automatically generated, incremented anchor links (e.g., #yup, #yup-1, etc.) to maintain uniqueness. However, when manually linking to these sections within the same document, it's essential to use the correct, unique anchor link to ensure the reader is directed to the intended section.

By making this change, we aim to:

  • Improve the readability and navigability of the README.
  • Ensure that links within the document are accurate and lead to the correct sections, enhancing the overall user experience.

Example

Here is how the updated links would be used in practice:

  • Link to the first yup section: yup
  • Link to the second yup section: yup

Thank you for considering this improvement to the README documentation. I believe these changes will make it easier for readers to navigate the document and find the information they need efficiently.

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