Skip to content

[FEATURE] Enhance 'Star on GitHub' button with star count and correct repository link #4357

@Shubhashish-Chakraborty

Description

Why do we need this improvement?

hey Maintainers 😄 , I've noticed a couple of areas for improvement on the website's navbar that I believe will enhance the user experience and engagement. I'd love to work on this if you agree!, explaning everything below, with proper demo:

Current State:

  • The Star on GitHub button is visually simple and doesn't display the current star count of the repository.

  • Repository Link: The button currently redirects to the github.com/asyncapi/spec repository. So actually this is my doubt that, whether this is the correct repo link or not, coz i thought the main repo is github.com/asyncapi/website.

Here is a screenshot of the current button:

Image

Below is the demo, do watch the Video! and screenshots:

I have already implemented these changes locally and can create a pull request as soon as this proposal is approved.

Please assign this issue to me if you'd like me to proceed!, I will make a PR then 😄 , Thankyou!

How will this change help?

  • Adding the star count provides immediate social proof and can encourage more users to star the project, it enhances the UX right at some point i believe.!!
  • As this is an important repo, visitors on the website might be more interested in the website's own source code, which is in the asyncapi/website repository.

Screenshots

do watch the video: (that shiny look and all on hover)

demo.mp4

screenshots:

Image Image

How could it be implemented/designed?

I WILL DO THE FOLLOWING ENHANCMENTS:

  • UI/UX Improvement: Redesign the button to be more visually appealing.
  • Add Star Count: Fetch the star count from the GitHub API and display it dynamically next to the star icon. The count will update automatically!!
  • Update Repository Link (On Your Approval & Guidance): I believe the link should point to asyncapi/website. However, I'd like to confirm with the maintainers if this is the correct repository to link to, or if asyncapi/spec is the intended destination. Could you please clarify which one would be more appropriate?

AND i will mention and explaing the code changes, file changes and all in the PR!, I hope its fine 😄

🚧 Breaking changes

Yes

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions