Add "Back to Top" Links in README for Better Navigation #140

Aripilli-Bhavana · 2025-07-28T06:11:26Z

The current README.md is too long and contains multiple sections. Scrolling through it can be cumbersome, especially for new users or contributors accessing it on smaller screens.

💡 Proposed Solution
Add [🔝 Back to Top] links at the end of major sections in the README

Optionally add a top anchor like (though GitHub supports #readme by default)

Maintain consistent formatting across all sections

Issue number #139

Summary by CodeRabbit

Documentation
- Added a "Back to Top" button at the end of the README for easier navigation.

netlify · 2025-07-28T06:11:31Z

✅ Deploy Preview for github-spy ready!

Name	Link
🔨 Latest commit	`dcf9514`
🔍 Latest deploy log	https://app.netlify.com/projects/github-spy/deploys/6887149190a63f0008512d60
😎 Deploy Preview	https://deploy-preview-140--github-spy.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-07-28T06:11:35Z

Walkthrough

A  HTML anchor comment was added at the start of the README. At the end, a horizontal rule and a centered "Back to Top" link styled as a button were appended, allowing readers to quickly navigate to the top of the document.

Changes

Cohort / File(s)	Change Summary
README navigation update `README.md`	Added `<!-- top -->` anchor at the top; appended a horizontal rule and a styled "Back to Top" link at the bottom.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A hop to the top, a leap with delight,
Now README navigation is easy and light.
With anchors and buttons, we rabbits approve—
Quick jumps for all, so smooth to move!
🐇⬆️

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions

🎉 Thank you @Aripilli-Bhavana for your contribution. Please make sure your PR follows https://github.com/GitMetricsLab/github_tracker/blob/main/CONTRIBUTING.md#-pull-request-guidelines

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)
149-158: Inline styles will be stripped & extra blank lines add noise

GitHub’s sanitizer removes the style attribute, so the button styling will not survive.

Five empty lines + a second horizontal rule produce unnecessary vertical whitespace.

A cleaner, markdown-native alternative:
-
----
-
-<p align="center">
-  <a href="#top" style="font-size: 18px; padding: 8px 16px; display: inline-block; border: 1px solid #ccc; border-radius: 6px; text-decoration: none;">
-    ⬆️ Back to Top
-  </a>
-</p>
+<p align="center">[⬆️ Back&nbsp;to&nbsp;Top](#top)</p>
This keeps the link centered without relying on stripped HTML/CSS and removes superfluous blank lines.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 251b486 and dcf9514.

📒 Files selected for processing (1)

README.md (2 hunks)

🔇 Additional comments (1)

README.md (1)

2-2:  is not a functional anchor on GitHub-rendered Markdown

A plain HTML comment does not create an element with id="top", so href="#top" relies on browsers falling back to “scroll to beginning” (which is inconsistent) rather than a guaranteed anchor. Either drop the custom target and link to GitHub’s built-in #readme, or emit a real anchor element.
-
+<a id="top"></a>
Please open the README in the GitHub UI and confirm the link actually scrolls; if it doesn’t, adopt the fix above or switch the link to #readme.

github-actions · 2025-07-28T09:48:16Z

🎉🎉 Thank you for your contribution! Your PR #140 has been merged! 🎉🎉

Update README.md

dcf9514

github-actions bot added the gssoc25 label Jul 28, 2025

github-actions bot reviewed Jul 28, 2025

View reviewed changes

coderabbitai bot reviewed Jul 28, 2025

View reviewed changes

mehul-m-prajapati added the level1 label Jul 28, 2025

mehul-m-prajapati merged commit 9365a75 into GitMetricsLab:main Jul 28, 2025
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add "Back to Top" Links in README for Better Navigation #140

Add "Back to Top" Links in README for Better Navigation #140

Uh oh!

Aripilli-Bhavana commented Jul 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Jul 28, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 28, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

github-actions bot commented Jul 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add "Back to Top" Links in README for Better Navigation #140

Add "Back to Top" Links in README for Better Navigation #140

Uh oh!

Conversation

Aripilli-Bhavana commented Jul 28, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

netlify bot commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for github-spy ready!

Uh oh!

coderabbitai bot commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jul 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Aripilli-Bhavana commented Jul 28, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Jul 28, 2025 •

edited

Loading

coderabbitai bot commented Jul 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)