Skip to content

[BUG] Fix Broken Local File Traversal Links and Formatting in README Anchor NavigationΒ #10

@Vedant4102004

Description

@Vedant4102004

πŸ“Œ Problem Description
The README.md header menu features quick shortcut navigation paths (Detailed Guide β€’ Help β€’ What's Next). However, because the target section headers contain complex emoji prefixes and special punctuation (such as ## πŸ“š Detailed Step-by-Step Guide and ## πŸ†˜ Stuck? Get Help!), standard GitHub Markdown anchor parsers fail to map them properly. Clicking these shortcuts results in dead navigation hops.

πŸ’‘ Proposed Solution
Clean up and explicitly map the relative markdown anchors to match standard GitHub auto-generated slug profiles:

  • Audit and adjust the top shortcut references format from placeholder words to precise slug forms (e.g., replace standard text markers with exact lowercase dash structures like #-detailed-step-by-step-guide or #-stuck-get-help).
  • Ensure all quick link headers loop users to the exact intended subsection cleanly.

πŸ› οΈ Technical Domain & Directory Focus
Target File: README.md
Concepts Covered: Markdown Anchor Mapping, Hyperlink Auditing, Document Navigation Design.

πŸ“‹ Acceptance Criteria

  • Clicking "Detailed Guide", "Help", or "What's Next" from the top menu bar must scroll the page instantly to its respective destination block.
  • No dead or unmapped anchor variables should remain in the baseline documentation file.

@Adez017 please assign this issue to me i am nsoc contributor.

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions