docs: add Table of Contents to Readme #111
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Pull Request Template
📄 Description
This PR adds a clear and clickable Table of Contents (TOC) to the README to improve navigation and readability.
The README had grown long, making it difficult for contributors and reviewers to quickly jump to specific sections.
This change helps users navigate the documentation more efficiently.
🔗 What was done
🧪 Proof of Work
Before:
After:
🔗 Related Issues
🧩 Type of Change
✅ Checklist
💬 Additional Notes (Optional)
This contribution is part of the Winter of Code (WoC) program.