docs: add Table of Contents to README for better navigation

[Xenon010101]

What

Add a linked Table of Contents to README for better navigation.

Root cause

README was lengthy with no quick way to jump to sections.

Changes

• Added a Table of Contents section between the project intro and AI Assistant Context Files
• 13 linked entries covering all top-level sections (## headings)
• Clean anchor links matching GitHub's auto-generated heading IDs

Verification

• All links use lowercase, hyphen-separated anchor format
• No broken markdown syntax

CI failures

N/A

Before

Users had to scroll through the entire README to find specific sections.

After

Linked Table of Contents at the top for one-click navigation.

Closes #1432

Summary by CodeRabbit

• Documentation
  • Added a Table of Contents to the README with anchor links for improved navigation between sections.

[github-actions]

Hi @Xenon010101, thanks for contributing to InternHack! 🎉

I have automatically:

• 👤 Assigned this PR to you.
• 🏷️ Applied the gssoc:approved label.

Our workflows will now analyze your changes to classify:

• 📈 PR Difficulty: level:*
• 🧩 PR Type: type:*
• 🌟 PR Quality: quality:*

Tip

Ensure your PR description references the issue it resolves (e.g. Closes #123). This allows the bot to inherit any additional labels from that issue!

Happy coding! 🚀

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8e2f4cf9-625f-4c3f-ad07-e1c5aafc82bd

📥 Commits

Reviewing files that changed from the base of the PR and between 0c176ae and 048b0ac.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

This PR adds a Table of Contents section to the README with anchor-linked entries for major documentation sections. The navigation links are positioned before the existing content, enabling readers to quickly jump to relevant information.

Changes

README Table of Contents

Layer / File(s)	Summary
Table of Contents section README.md	A bulleted list of anchor-linked navigation entries for README sections (About, AI Assistant Context Files, Tech Stack, Features, Getting Started, Environment Variables, Project Structure, API Overview, Production Build, Contributing, Contributors, Project Support, License) is inserted at the top of the document.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Sachinchaurasiya360/InternHack#357: Both PRs modify README.md documentation structure, with this PR adding a Table of Contents for improved navigation.
• Sachinchaurasiya360/InternHack#438: Both PRs alter README.md section structure; this PR adds a Table of Contents while the other reshapes section headings.
• Sachinchaurasiya360/InternHack#732: Both PRs modify README documentation related to the "AI Assistant Context Files" section area.

Suggested labels

documentation, type:docs, level:beginner

Poem

🐰 A table of contents, hopping with care,
Leads readers through README everywhere,
Links organized, neat, and so clean,
The best navigation they've ever seen! 📚✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title clearly and concisely describes the main change—adding a Table of Contents to README for better navigation.
Description check	✅ Passed	The PR description provides clear context (What/Root cause/Changes/Verification) but omits several template sections like Type of Change and Testing details.
Linked Issues check	✅ Passed	The PR successfully implements all requirements from issue #1432: TOC added after intro, includes all 13 primary sections with proper anchor links, and uses correct lowercase hyphen-separated format.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to issue #1432—only the README TOC addition with no unrelated modifications to codebase, tests, or other files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}