Skip to content

docs: improve README navigation, links, and contribution guidance#41

Open
NishuRajput12 wants to merge 2 commits intoAOSSIE-Org:mainfrom
NishuRajput12:docs-readme-improvement
Open

docs: improve README navigation, links, and contribution guidance#41
NishuRajput12 wants to merge 2 commits intoAOSSIE-Org:mainfrom
NishuRajput12:docs-readme-improvement

Conversation

@NishuRajput12
Copy link

@NishuRajput12 NishuRajput12 commented Feb 11, 2026

Improved README by:

  • Adding Table of Contents
  • Converting absolute links to relative links
  • Adding "How to Contribute" section
  • Minor consistency and formatting fixes

Summary by CodeRabbit

  • Documentation

    • Added Table of Contents and separators for easier navigation
    • Converted external links to local/relative document references (including contributor, mentor, ambassador, and GSoC guides)
    • Introduced a step-by-step "How to Contribute" workflow
    • Expanded guidance sections and "Who Should Use This Repository?" roles
    • Updated document index with local paths and added a "Last updated" timestamp
  • Chores

    • Minor formatting, spacing, and trailing-whitespace cleanup

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 11, 2026

📝 Walkthrough

Walkthrough

The README.md file has been reorganized with a new Table of Contents section, relative documentation links replacing absolute GitHub URLs, and a new contribution workflow subsection. Document index and guidance sections have been updated with local file references and minor formatting adjustments.

Changes

Cohort / File(s) Summary
Documentation Structure & Links
README.md
Added Table of Contents and separators; replaced absolute GitHub URLs with relative/local links across Communication, Social Media, Mentors/Ambassadors, GSoC, and Document Index sections; added "🛠 How to Contribute to This Repository" step-by-step workflow; updated last-updated timestamp and minor whitespace/formatting fixes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • Zahnentferner

Poem

🐰 A README polished, neat and spry,
A table of contents hops right by,
Old links turned local, tidy and bright,
Contribution steps laid out just right,
I nibble bugs and cuddle docs tonight! 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: improve README navigation, links, and contribution guidance' accurately summarizes the main changes: adding Table of Contents for navigation, converting links, and introducing contribution guidance.
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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 11-20: Update the Table of Contents anchor fragments so they match
GitHub-generated heading slugs by removing leading emojis/punctuation and any
stray leading hyphens; replace entries like `#-who-should-use-this-repository`,
`#-guidance-for-contributors`, `#-guidance-for-mentors`,
`#-guidance-for-admins`, `#-guidance-for-ambassadors`, `#-document-index`,
`#-important-notes`, and `#-final-note` with the correct slugs such as
`#who-should-use-this-repository`, `#guidance-for-contributors`,
`#guidance-for-mentors`, `#guidance-for-admins`, `#guidance-for-ambassadors`,
`#document-index`, `#important-notes`, and `#final-note` so the links resolve on
GitHub.

@NishuRajput12
Copy link
Author

Hi @Rafiaminhaj,
Just a gentle reminder regarding this PR. Please let me know if any changes are needed from my side.
Happy to update it. Thanks!

@NishuRajput12
Copy link
Author

Hi @Rafiaminhaj,
Just a gentle reminder regarding this PR (#41). Please let me know if any changes are needed from my side.
Happy to update it. Thanks!

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