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 Specification Explorer to mobile dropdown and unify Migration spelling (#3727) #3731

Conversation

rathoretaruncodes
Copy link

@rathoretaruncodes rathoretaruncodes commented Feb 24, 2025

Related issue(s)
Fixes #3727

Description

  • Added "Specification Explorer" to the mobile dropdown.
  • Unified the spelling of "Migration" across all views (removed extra 's').
  • Fixed inconsistencies in navigation between desktop and mobile views.

Screenshots
Desktop:
Screenshot 2025-02-24 215023

Mobile:
Screenshot 2025-02-24 215504

Summary by CodeRabbit

  • New Features

    • Added a "Specification Explorer" navigation item with a distinctive style and description to help users access specification documentation more easily.
  • Refactor

    • Updated the title of an existing navigation item from "Migrations" to "Migration" for improved clarity.

Copy link
Contributor

coderabbitai bot commented Feb 24, 2025

Walkthrough

This commit updates the navigation learning items by adding a new entry for "Specification Explorer." The update includes importing the required icon component (IconExplorer) and detailing the new learning item’s properties such as URL, styling, title, and description. Additionally, an existing learning item’s title was modified from "Migrations" to "Migration."

Changes

File(s) Change Summary
components/navigation/learningItems.tsx - Added new icon import: IconExplorer
- Added learning item with href /docs/reference/specification/v3.0.0-explorer, bg-teal-200 styling, title "Specification Explorer", and custom description
- Changed existing item's title from "Migrations" to "Migration"

Possibly related PRs

Suggested labels

ready-to-merge

Suggested reviewers

  • derberg
  • magicmatatjahu
  • anshgoyalevil
  • BhaswatiRoy
  • VaishnaviNandakumar
  • devilkiller-ag
  • sambhavgupta0705
  • akshatnema

Poem

I'm a little rabbit, hopping through our code,
Adding new paths where explorers now strode.
With icons so lively and names updated too,
Navigation's a garden where fresh ideas grew.
Hop on, dear coder, for a joyful review! 🐰


📜 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 6399887 and d512f88.

📒 Files selected for processing (1)
  • components/navigation/learningItems.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/navigation/learningItems.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

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link

netlify bot commented Feb 24, 2025

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit d512f88
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67bca443bc264700081e0ad8
😎 Deploy Preview https://deploy-preview-3731--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.

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: 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 89c7f7a and 6399887.

📒 Files selected for processing (1)
  • components/navigation/learningItems.tsx (3 hunks)
🧰 Additional context used
🪛 ESLint
components/navigation/learningItems.tsx

[error] 1-10: Run autofix to sort these imports!

(simple-import-sort/imports)


[error] 75-75: Delete ,

(prettier/prettier)


[error] 75-75: Unexpected trailing comma.

(comma-dangle)

🪛 GitHub Actions: PR testing - if Node project
components/navigation/learningItems.tsx

[error] 1-1: Run autofix to sort these imports! simple-import-sort/imports


[error] 75-75: Delete , prettier/prettier


[error] 75-75: Unexpected trailing comma. comma-dangle

⏰ Context from checks skipped due to timeout of 180000ms (1)
  • GitHub Check: Lighthouse CI
🔇 Additional comments (2)
components/navigation/learningItems.tsx (2)

60-60: LGTM! Consistent terminology.

The title change from 'Migrations' to 'Migration' aligns with the PR objective to standardize terminology and matches the URL path.


70-75: LGTM! Well-structured addition.

The new Specification Explorer learning item follows the established pattern and provides clear, informative content. The addition aligns with the PR objective to improve navigation accessibility.

🧰 Tools
🪛 ESLint

[error] 75-75: Delete ,

(prettier/prettier)


[error] 75-75: Unexpected trailing comma.

(comma-dangle)

🪛 GitHub Actions: PR testing - if Node project

[error] 75-75: Delete , prettier/prettier


[error] 75-75: Unexpected trailing comma. comma-dangle

icon: IconExplorer,
className: 'bg-teal-200',
title: 'Specification Explorer',
description: 'Simplifying our Specification JSON Schema like a pro.',
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix trailing comma.

Remove the trailing comma to resolve linting errors.

Apply this diff to fix the trailing comma:

    title: 'Specification Explorer',
-   description: 'Simplifying our Specification JSON Schema like a pro.',
+   description: 'Simplifying our Specification JSON Schema like a pro.'
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
description: 'Simplifying our Specification JSON Schema like a pro.',
title: 'Specification Explorer',
description: 'Simplifying our Specification JSON Schema like a pro.'
🧰 Tools
🪛 ESLint

[error] 75-75: Delete ,

(prettier/prettier)


[error] 75-75: Unexpected trailing comma.

(comma-dangle)

🪛 GitHub Actions: PR testing - if Node project

[error] 75-75: Delete , prettier/prettier


[error] 75-75: Unexpected trailing comma. comma-dangle

@@ -7,6 +7,7 @@
import IconPlant from '../icons/Plant';
import IconRocket from '../icons/Rocket';
import IconUsers from '../icons/Users';
import IconExplorer from '../icons/Explorer';
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix import sorting.

The import statements need to be sorted according to the project's linting rules.

Apply this diff to fix the import sorting:

 import type React from 'react';

+import IconExplorer from '../icons/Explorer';
 import IconGradCap from '../icons/GradCap';
 import IconGuide from '../icons/Guide';
 import IconMigration from '../icons/Migration';
 import IconPaper from '../icons/Paper';
 import IconPlant from '../icons/Plant';
 import IconRocket from '../icons/Rocket';
 import IconUsers from '../icons/Users';
-import IconExplorer from '../icons/Explorer';
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
import IconExplorer from '../icons/Explorer';
import type React from 'react';
import IconExplorer from '../icons/Explorer';
import IconGradCap from '../icons/GradCap';
import IconGuide from '../icons/Guide';
import IconMigration from '../icons/Migration';
import IconPaper from '../icons/Paper';
import IconPlant from '../icons/Plant';
import IconRocket from '../icons/Rocket';
import IconUsers from '../icons/Users';
🧰 Tools
🪛 ESLint

[error] 1-10: Run autofix to sort these imports!

(simple-import-sort/imports)

Copy link

codecov bot commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (89c7f7a) to head (d512f88).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3731   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines          732       732           
=========================================
  Hits           732       732           

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

@anshgoyalevil
Copy link
Member

Thanks @rathoretaruncodes
Since there was another PR created by the author of this issue, I decided to merge that. Feel free to create some different issue and a PR for that.

@rathoretaruncodes
Copy link
Author

rathoretaruncodes commented Feb 26, 2025

Hi @anshgoyalevil @antoniogarrote @scharrier @devilkiller-ag ,

I understand that the author's PR was merged instead of mine. However, I would like to highlight a few points:

  • If only an author's PRs get merged (despite me raising the PR first), it may lead to everyone opening issues.
  • This increases the probability of meaningless issues being raised.
  • Consequently, it results in more workload for the team to filter out useless PRs.

I believe that considering contributions from all community members can be beneficial for the project. Please let me know how we can improve this process.

Thanks,
@rathoretaruncodes

@anshgoyalevil
Copy link
Member

@rathoretaruncodes why do you think that opening a PR on an issue that was spotted by someone else would be prioritized over the PR that was created by the author of that issue after approval from the maintainers?

Spotting an issue is as important as resolving it. You cannot just create a PR for the issue opened by someone else who is willing to work on it.

@rathoretaruncodes
Copy link
Author

@anshgoyalevil @antoniogarrote @scharrier @devilkiller-ag @derberg

Why do I think my issue should've been merged?

  • Equal Value: Identifying an issue is important, but delivering a high-quality, tested fix is just as crucial.

  • Quality Over Origin: Contributions should be judged on their technical merit and adherence to guidelines—not just on who reported the issue.

  • Guideline Adherence: My PR follows our established contribution standards, ensuring consistency and maintainability.

##3727 (comment)
Screenshot 2025-02-27 193428

Also, No one was approved/ assigned for this issue in particular

Screenshot 2025-02-27 201258

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.

[BUG] Mobile view missing "Specification Explorer" & spelling inconsistency in "Migration"
2 participants