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: Spec Explorer link in Docs #3428

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

Conversation

dishafaujdar
Copy link

@dishafaujdar dishafaujdar commented Nov 25, 2024

The browser requests in
https://github.com/asyncapi/website/blob/master/components/data/buckets.ts#L96
'Explorer,' but
the App Router in
https://github.com/asyncapi/website/blob/master/components/layout/DocsLayout.tsx#L92
is looking for 'explorer.'
It does not find it and returns an HTTP 404 error in the local environment.

This PR fixes the inconsistency, ensuring the link returns the correct page after clicking on 'Docs / Specification Explorer'.

Summary by CodeRabbit

  • New Features

    • Enhanced the Calendar component to ensure it occupies the full height of its parent container for improved layout.
  • Bug Fixes

    • Updated the link for the "Explorer" bucket to correct the case in the URL, ensuring accurate access to the Specification Explorer documentation.

Copy link

coderabbitai bot commented Nov 25, 2024

Walkthrough

The pull request introduces two main changes: the Calendar component in components/Calendar.tsx now includes the h-full class in its main <div>, ensuring it occupies the full height of its parent container. Additionally, the link property of the last bucket object in components/data/buckets.ts is updated to change the case of "Explorer" to "explorer" in the URL, correcting a potential issue with accessing the Specification Explorer documentation.

Changes

File Change Summary
components/Calendar.tsx Added h-full class to the main <div> to ensure full height of the parent container.
components/data/buckets.ts Updated the link for the "Explorer" bucket from /docs/reference/specification/v3.0.0-Explorer to /docs/reference/specification/v3.0.0-explorer.

Possibly related issues

  • fix: Spec Explorer link in Docs #3427: Addresses a bug where the link for the Specification Explorer was case-sensitive, leading to a 404 error. This PR resolves the inconsistency by updating the link case.

Suggested labels

ready-to-merge

Suggested reviewers

  • asyncapi-bot-eve
  • devilkiller-ag
  • BhaswatiRoy
  • akshatnema
  • Mayaleeeee
  • quetzalliwrites
  • anshgoyalevil
  • TRohit20

Poem

🐰 In the calendar's embrace, we find,
A height so grand, it’s truly aligned.
The explorer's path, now clear and bright,
With links that guide us, day and night.
Hopping through docs, with joy we cheer,
For every change, brings us near! 🌟


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 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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Nov 25, 2024

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

 The subject "Spec Explorer link in Docs" found in the pull request title "fix: Spec Explorer link in Docs" should start with a lowercase character.

Copy link

netlify bot commented Nov 25, 2024

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit 51510a7
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/674577d5219dac0008e1eec5
😎 Deploy Preview https://deploy-preview-3428--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 Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.77%. Comparing base (7669160) to head (51510a7).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3428   +/-   ##
=======================================
  Coverage   67.77%   67.77%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          450      450           
  Misses        214      214           

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

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Nov 25, 2024

⚡️ Lighthouse report for the changes in this PR:

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

Lighthouse ran on https://deploy-preview-3428--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: 0

🧹 Outside diff range and nitpick comments (1)
components/data/buckets.ts (1)

97-98: Fix inconsistent border color class.

The borderClassName is using border-orange-200 while the background uses bg-teal-200. For consistency, consider using border-teal-200 instead.

    className: 'bg-teal-200',
-   borderClassName: 'border-orange-200',
+   borderClassName: 'border-teal-200',
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 914ab3b and 1d2df63.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (2)
  • components/Calendar.tsx (1 hunks)
  • components/data/buckets.ts (1 hunks)
🔇 Additional comments (3)
components/Calendar.tsx (2)

34-34: LGTM: Height styling change looks good

The addition of the h-full class is a valid styling change that will make the calendar component fill its parent container's height.


34-34: Verify: Calendar styling change seems unrelated to PR objectives

This styling change appears unrelated to the PR's stated objective of fixing the Specification Explorer link casing issue. Please clarify if this change is intentional or should be moved to a separate PR.

components/data/buckets.ts (1)

96-96: LGTM! URL case change fixes the 404 error.

The lowercase 'explorer' in the URL aligns with the App Router's expectations, resolving the reported 404 error when accessing the Specification Explorer documentation.

Copy link
Member

Choose a reason for hiding this comment

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

why this change is made?

Copy link
Member

Choose a reason for hiding this comment

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

Why this line is added here?

Copy link
Author

Choose a reason for hiding this comment

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

Akshat, I had branched from the wrong branch and have already fixed it.

Copy link
Member

Choose a reason for hiding this comment

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

Can you please remove these changes from this PR?

Copy link
Author

Choose a reason for hiding this comment

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

Yeah sure

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.

3 participants