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: Added 'Specification Explorer' to mobile view & fixed spelling inconsistency #3732

Closed
wants to merge 4 commits into from

Conversation

PRAteek-singHWY
Copy link
Contributor

@PRAteek-singHWY PRAteek-singHWY commented Feb 24, 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:-
Screenshot 2025-02-24 at 15 15 00

After:-

Screenshot 2025-02-25 at 00 21 56

Fixes #3727

Summary by CodeRabbit

  • New Features

    • Introduced a new learning item titled "Specification Explorer" to enhance navigation and resource discovery.
    • Updated an existing learning item’s title for improved clarity.
  • Chores

    • Added metadata to the project configuration to specify the package management tool and version.
  • UI Enhancements

    • Modified button label in the DocsLayout component to display the post's title for better user experience.

Copy link
Contributor

coderabbitai bot commented Feb 24, 2025

Walkthrough

This pull request updates the navigation by appending a new learning item—“Specification Explorer”—to the learning items array and updating the title of the migration item from "Migrations" to "Migration". Additionally, the package.json file now includes a new "packageManager" property that documents the package management tool and its version. No control flow or public API changes were made.

Changes

File Change Summary
components/navigation/learningItems.tsx Added a new learning item ("Specification Explorer") with properties (href, icon, className, title, description) and updated "Migrations" to "Migration".
package.json Added a "packageManager" property specifying the yarn version and a SHA-512 checksum.
components/layout/DocsLayout.tsx Modified the button text from {post.sectionTitle} to {post.title} in the DocsLayout component.

Suggested labels

ready-to-merge

Suggested reviewers

  • derberg
  • akshatnema
  • magicmatatjahu
  • asyncapi-bot-eve
  • Mayaleeeee

Poem

I'm a rabbit, hopping with delight,
Code changes bright as a starlit night.
New items bloom, old titles tweaked,
In fields of code, each line is unique.
I nibble on bits and celebrate with a hop so sleek!


📜 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 2395bbd and 706c177.

📒 Files selected for processing (1)
  • components/layout/DocsLayout.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/layout/DocsLayout.tsx
⏰ Context from checks skipped due to timeout of 180000ms (1)
  • GitHub Check: Lighthouse CI

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 24, 2025

Deploy Preview for asyncapi-website failed.

Built without sensitive environment variables

Name Link
🔨 Latest commit 706c177
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67bdf8d0ff87580008e2f14c

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 (69d74a6) to head (706c177).
Report is 23 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3732   +/-   ##
=========================================
  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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Feb 24, 2025

We require all PRs to follow Conventional Commits specification.
More details 👇🏼

 The subject "Added 'Specification Explorer' to mobile view & fixed spelling inconsistency" found in the pull request title "fix: Added 'Specification Explorer' to mobile view & fixed spelling inconsistency" should start with a lowercase character.

@PRAteek-singHWY PRAteek-singHWY changed the title fix: Added 'Specification Explorer' to mobile view & fixed spelling inconsistency fix: Added 'Specification Explorer' to mobile view & fixed spelling inconsistency Feb 24, 2025
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