docs: improve README navigation and contribution guidance

[Arbaaz123676]

Summary

Improves README navigation and usability.

Changes

• Added a Table of Contents
• Converted absolute GitHub links to relative links
• Improved readability and structure

Notes

Only documentation structure improvements.
Fixes #40.

Summary by CodeRabbit

• Documentation
  • Added a Table of Contents to the README for improved navigation.
  • Replaced absolute links with relative/local links across multiple guidance pages (communication, social media, copyright, GSoC, ambassadors).
  • Added a "How to Contribute" section with basic contribution steps.
  • Updated the Document Index to reference local document paths.

[coderabbitai]

📝 Walkthrough

Walkthrough

The README.md was updated to add a Table of Contents, a "How to Contribute" section, and to replace several absolute GitHub links with relative/local links across Communication Guidelines, Social Media Guidelines, Copyright Information, Google Summer of Code Guidelines, Ambassadors Program, and the Documents Index.

Changes

Cohort / File(s)	Summary
Documentation / README README.md	Added Table of Contents and "How to Contribute" section; converted multiple absolute GitHub links to relative/local paths across communication, social media, copyright, GSoC, Ambassadors, and updated the Documents Index entries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• docs: add role-based guidance and navigation links to README #9: Modifies README.md to reorganize navigation and convert links to local paths, closely related to this change.

Suggested reviewers

• Zahnentferner

Poem

🐰
A tiny hop, a tidy tree of contents bright,
Links once far, now homeward — everything in sight.
New steps to help contributors find their way,
I nibble at docs and cheer for this clear day. 🥕✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: improving README navigation and contribution guidance through a Table of Contents, relative links, and a contribution section.
Linked Issues check	✅ Passed	All coding objectives from issue #40 are met: Table of Contents added, absolute links converted to relative links, How to Contribute section added, and document naming consistency improved.
Out of Scope Changes check	✅ Passed	All changes are directly aligned with the objectives in issue #40 and README documentation improvements; no out-of-scope changes detected.
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
• Post copyable unit tests in a comment

---

No actionable comments were generated in the recent review. 🎉

---

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.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@README.md`:
- Around line 10-15: The Table of Contents links currently point to header
fragments that may not match GitHub's anchor generation; update either the link
fragments or the corresponding headings so they match GitHub-style anchors
(lowercase, spaces → hyphens, remove punctuation and emojis). Specifically
verify and fix the TOC entries for "Who Should Use This Repository?", "Guidance
for Contributors", and "Required Reading (Before Contributing)" so their
fragments become e.g. `#who-should-use-this-repository`,
`#guidance-for-contributors`, and `#required-reading-before-contributing`, or
alternatively remove/adjust punctuation or emojis from the headings to make the
generated anchors match the existing links.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Confirm TOC link fragments resolve correctly.

markdownlint flagged invalid fragments for the new TOC entries, which can happen when headings include emojis or punctuation. Please verify the generated anchor IDs match the links (GitHub vs. other renderers) and adjust if needed to avoid broken navigation.

🧰 Tools

🪛 markdownlint-cli2 (0.20.0)

[warning] 12-12: Link fragments should be valid

(MD051, link-fragments)

---

[warning] 13-13: Link fragments should be valid

(MD051, link-fragments)

🤖 Prompt for AI Agents

In `@README.md` around lines 10 - 15, The Table of Contents links currently point
to header fragments that may not match GitHub's anchor generation; update either
the link fragments or the corresponding headings so they match GitHub-style
anchors (lowercase, spaces → hyphens, remove punctuation and emojis).
Specifically verify and fix the TOC entries for "Who Should Use This
Repository?", "Guidance for Contributors", and "Required Reading (Before
Contributing)" so their fragments become e.g. `#who-should-use-this-repository`,
`#guidance-for-contributors`, and `#required-reading-before-contributing`, or
alternatively remove/adjust punctuation or emojis from the headings to make the
generated anchors match the existing links.