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 view and fix spelling inconsistency #3737

Merged

Conversation

PRAteek-singHWY
Copy link
Contributor

@PRAteek-singHWY PRAteek-singHWY commented Feb 25, 2025

This PR fixes two issues:

  1. The "Specification Explorer" tab was missing in the mobile view but was visible in the desktop view.
  2. The spelling of "Migration" was inconsistent. It appeared as "Migrations" in the mobile view.

These issues are now resolved to ensure a consistent navigation experience across devices.

Before:-

imageedit_4_8739910269

After:-

imageedit_2_9083419206

Fixes #3727

Summary by CodeRabbit

  • New Features

    • Introduced a new navigation item, "Specification Explorer," featuring its own icon, background styling, and a descriptive summary.
  • Refactor

    • Updated the label of an existing learning item from "Migrations" to "Migration" for improved consistency.

Copy link
Contributor

coderabbitai bot commented Feb 25, 2025

Walkthrough

This change updates the navigation learning items by adding a new entry for the "Specification Explorer" with a defined URL, icon, background class, title, and description. It also adjusts the title for the existing "Migrations" item by changing it to "Migration". The modifications ensure that the navigation resource list accurately reflects the intended resources.

Changes

File Path Change Summary
components/navigation/learningItems.tsx Added a new learning item for "Specification Explorer" and modified the title for "Migrations" to "Migration".

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant N as Navigation Component
    participant LI as Learning Items List

    U->>N: Load navigation menu
    N->>LI: Render learning items ("Specification Explorer", "Migration", etc.)
    U->>N: Click on "Specification Explorer"
    N->>U: Redirect to /docs/reference/specification/v3.0.0-explorer
Loading

Possibly related PRs

Suggested labels

ready-to-merge

Suggested reviewers

  • derberg
  • devilkiller-ag
  • akshatnema
  • sambhavgupta0705
  • anshgoyalevil
  • Mayaleeeee

Poem

I hopped through lines of code today,
Adding features in my own rabbit way.
Specification Explorer now shines so bright,
And "Migration" makes our path just right.
With nimble leaps, our code takes flight!
🐇✨


📜 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 89c7f7a and 0150b8c.

📒 Files selected for processing (1)
  • components/navigation/learningItems.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (1)
  • GitHub Check: Lighthouse CI
🔇 Additional comments (3)
components/navigation/learningItems.tsx (3)

3-3: Added appropriate import for new feature.

The import for IconExplorer is correctly added to support the new Specification Explorer navigation item.


60-60: Fixed spelling inconsistency.

Changed "Migrations" to "Migration" as mentioned in the PR objectives, ensuring consistent terminology throughout the application.


69-76: Successfully added Specification Explorer to navigation.

The new learning item for the Specification Explorer follows the established pattern of other navigation items with appropriate values for all required properties. This change effectively addresses the primary objective of adding the Specification Explorer to the mobile view.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 Feb 25, 2025

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

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

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f5e40b3) to head (851a8bf).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3737   +/-   ##
=========================================
  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 anshgoyalevil changed the title fix: Added 'Specification Explorer' to mobile view & fixed spelling inconsistency fix: add specification explorer to mobile view and fix spelling inconsistency Feb 26, 2025
@anshgoyalevil
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 8b378c9 into asyncapi:master Feb 26, 2025
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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