Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a "Back To Top" Button #178

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

Akhsuna07
Copy link

Pull Request

Description

I was going through this readme file, and it was too long, so I added a back-to-top button which improves the navigation throughout the page and makes readability easier.

Changes

I was going through this readme file, and it was too long, so I added a back-to-top button which improves the navigation throughout the page and makes readability easier.

Related Issues

Checklist

  • I have read and followed the project's contributing guidelines.
  • My code follows the project's coding style.
  • I have tested my changes thoroughly.
  • I have updated the documentation if necessary.
  • All existing tests pass.
  • I have added new tests to cover my changes.
  • My changes do not introduce any new warnings or errors.

Additional Comments

Reviewer Instructions

Author's Note

I was going through this readme file, and it was too long, so I added a back-to-top button which improves the navigation throughout the page and makes readability easier.
@arxyzan
Copy link
Member

arxyzan commented Oct 22, 2024

Hi @Akhsuna07, thanks for the PR.
I reviewed your changes. You are right about the README file being too long but I don't think a "back to top" button at the very end of the doc is beneficial that much. We as devs are all used to scrolling a lot so that's not a big deal ;). Meanwhile, the main README is just the showcase of the project and the main docs are located somewhere else (which does have a dynamic back to top button on every single page (handled by Sphinx).).

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.

2 participants