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

fix: add visual on the generators #3492

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

TenzDelek
Copy link
Contributor

@TenzDelek TenzDelek commented Dec 19, 2024

Description
added visual for generator
image

Related issue(s)

fixes #403

Summary by CodeRabbit

  • New Features
    • Added a visual enhancement to the Generator Page with a new image.

Copy link

coderabbitai bot commented Dec 19, 2024

Walkthrough

The pull request introduces a visual enhancement to the Generator page by adding an image that illustrates the generator's functionality. The new constant generatorimage is defined with a path to a diagram image, which is then rendered within the GeneratorPage component to provide a visual explanation of the generator's purpose and workflow.

Changes

File Change Summary
pages/tools/generator.tsx Added generatorimage constant with path to /img/diagrams/generator.webp and rendered the image in the component

Assessment against linked issues

Objective Addressed Explanation
Add visual to generator page [#403]

Poem

🐰 A rabbit's tale of code so bright,
A diagram leaps into visual light!
Generator's secrets now plain to see,
With one simple image, clarity breaks free.
Code and picture, a harmonious sight! 🖼️


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 13589a4 and f051594.

📒 Files selected for processing (1)
  • pages/tools/generator.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pages/tools/generator.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

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.

Copy link

netlify bot commented Dec 19, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 3913f3f
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/676a8bc844e2bf000807ebcd
😎 Deploy Preview https://deploy-preview-3492--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@TenzDelek TenzDelek changed the title fix: Add visual on the generators fix: add visual on the generators Dec 19, 2024
@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Dec 19, 2024

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 34
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3492--asyncapi-website.netlify.app/

Copy link

@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: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c90b564 and 2251d52.

⛔ Files ignored due to path filters (1)
  • public/img/diagrams/generator.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • pages/tools/generator.tsx (2 hunks)
🧰 Additional context used
🪛 eslint
pages/tools/generator.tsx

[error] 45-45: Expected blank line after variable declarations.

(newline-after-var)


[error] 45-45: Replace = with ·=·

(prettier/prettier)


[error] 45-45: Operator '=' must be spaced.

(space-infix-ops)


[error] 55-56: Replace "generator"·className='·mx-auto·h-auto·w-1/2·object-cover'·/>⏎ with 'generator'·className='·mx-auto·h-auto·w-1/2·object-cover'·/>

(prettier/prettier)


[error] 55-55: Unexpected usage of doublequote.

(jsx-quotes)

🔇 Additional comments (1)
pages/tools/generator.tsx (1)

45-45: Verify image asset existence and dimensions.

Let's ensure the image asset exists and has the correct dimensions.

🧰 Tools
🪛 eslint

[error] 45-45: Expected blank line after variable declarations.

(newline-after-var)


[error] 45-45: Replace = with ·=·

(prettier/prettier)


[error] 45-45: Operator '=' must be spaced.

(space-infix-ops)

pages/tools/generator.tsx Outdated Show resolved Hide resolved
pages/tools/generator.tsx Outdated Show resolved Hide resolved
@TenzDelek
Copy link
Contributor Author

image what might be the issue with permission ? do we need some permission for uploading image? perpexity says " Codecov action indicates that the process failed due to a lack of required authentication tokens when trying to create a report for a protected branch. " @sambhavgupta0705 , @derberg

Copy link
Member

Choose a reason for hiding this comment

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

Can we have this file in .webp format, as we have preferred way of img types as WEBP or SVG?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure

Copy link
Contributor Author

Choose a reason for hiding this comment

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

have made the changes cc @akshatnema

Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.47%. Comparing base (2199c3b) to head (3913f3f).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3492   +/-   ##
=======================================
  Coverage   86.47%   86.47%           
=======================================
  Files          21       21           
  Lines         658      658           
=======================================
  Hits          569      569           
  Misses         89       89           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@TenzDelek TenzDelek requested a review from akshatnema December 21, 2024 05:25
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.

Add visual on the "generator" and maybe others....
3 participants