fix: fix Spec Explorer link in Docs #3428

dishafaujdar · 2024-11-25T08:38:29Z

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

Bug Fixes
- Updated the URL for the "Explorer" bucket in the documentation links to ensure proper case sensitivity.

coderabbitai · 2024-11-25T08:38:36Z

Walkthrough

The changes in this pull request involve modifying the link property of the "Explorer" bucket object in the buckets array. The URL has been altered from /docs/reference/specification/v3.0.0-Explorer to /docs/reference/specification/v3.0.0-explorer, changing the case of "Explorer" to "explorer". This adjustment affects the URL structure for accessing the Specification Explorer documentation without introducing any additional modifications to the logic or error handling.

Changes

File Path	Change Summary
components/data/buckets.ts	Updated the `link` property for the "Explorer" bucket from `.../v3.0.0-Explorer` to `.../v3.0.0-explorer`.

Possibly related issues

fix: Spec Explorer link in Docs #3427: This issue addresses a bug related to the URL case sensitivity for the Specification Explorer link, which is directly resolved by the changes in this PR.

Possibly related PRs

docs: broken link to Generator Github Actions(#3190) #3299: This PR also updates a broken link in the documentation, similar to the URL correction made in this PR.

Suggested labels

ready-to-merge

Suggested reviewers

derberg
magicmatatjahu
anshgoyalevil
devilkiller-ag
asyncapi-bot-eve
sambhavgupta0705
akshatnema

Poem

🐰 In the land of docs, a change so bright,
The Explorer's link now shines just right.
From uppercase to lowercase, a simple fix,
No more 404s, just happy clicks!
Hop along, dear users, the path is clear,
The Specification Explorer is finally here! 🌟

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.

netlify · 2024-11-25T08:38:52Z

✅ Deploy Preview for asyncapi-website ready!

Name	Link
🔨 Latest commit	`f5f1ea1`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/6749ec1cdac1410008c0f694
😎 Deploy Preview	https://deploy-preview-3428--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

codecov · 2024-11-25T08:40:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.77%. Comparing base (e3c6bc9) to head (f5f1ea1).
Report is 1 commits behind head on master.

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 · 2024-11-25T08:42:10Z

⚡️ Lighthouse report for the changes in this PR:

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

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

coderabbitai

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.

akshatnema · 2024-11-25T19:24:52Z

components/Calendar.tsx

why this change is made?

I am trying to rm it but it is taking longer than I thought, because I am making a mistake somewhere, I'll do it today

@dishafaujdar Just remove this change manually from your branch, as at the end we are going to squash the commits.

akshatnema · 2024-11-25T19:25:11Z

package-lock.json

Why this line is added here?

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

Can you please remove these changes from this PR?

devilkiller-ag · 2024-11-28T01:03:00Z

@dishafaujdar The PR title subject should start with a lowercase character. Rename your PR to fix linting errors.

akshatnema

/rtm

akshatnema · 2024-11-29T19:00:10Z

/rtm

dishafaujdar requested review from derberg, akshatnema, magicmatatjahu, anshgoyalevil, Mayaleeeee and asyncapi-bot-eve as code owners November 25, 2024 08:38

asyncapi-bot requested review from devilkiller-ag and sambhavgupta0705 November 25, 2024 08:38

coderabbitai bot reviewed Nov 25, 2024

View reviewed changes

akshatnema requested changes Nov 25, 2024

View reviewed changes

dishafaujdar changed the title ~~fix: Spec Explorer link in Docs~~ fix: spec Explorer link in Docs Nov 28, 2024

dishafaujdar force-pushed the Spec branch from 51510a7 to a29550a Compare November 28, 2024 04:33

asyncapi-bot requested review from BhaswatiRoy, J0SAL, TRohit20 and VaishnaviNandakumar November 28, 2024 04:34

dishafaujdar changed the title ~~fix: spec Explorer link in Docs~~ fix: fix spec Explorer link in Docs Nov 29, 2024

dishafaujdar force-pushed the Spec branch from a29550a to fb8444c Compare November 29, 2024 04:58

dishafaujdar changed the title ~~fix: fix spec Explorer link in Docs~~ fix: fix Spec Explorer link in Docs Nov 29, 2024

dishafaujdar force-pushed the Spec branch from fb8444c to d2d7652 Compare November 29, 2024 11:00

dishafaujdar added 2 commits November 29, 2024 16:37

height

ded3704

without branched error

aeead75

aeworxet force-pushed the Spec branch from d2d7652 to aeead75 Compare November 29, 2024 14:39

Merge branch 'master' into Spec

f5f1ea1

akshatnema approved these changes Nov 29, 2024

View reviewed changes

akshatnema reviewed Nov 29, 2024

View reviewed changes

This comment was marked as duplicate.

Sign in to view

asyncapi-bot added the ready-to-merge label Nov 29, 2024

asyncapi-bot merged commit f726a6d into asyncapi:master Nov 29, 2024
18 checks passed

dishafaujdar deleted the Spec branch November 30, 2024 13:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: fix Spec Explorer link in Docs #3428

fix: fix Spec Explorer link in Docs #3428

dishafaujdar commented Nov 25, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 25, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

netlify bot commented Nov 25, 2024 •

edited

Loading

codecov bot commented Nov 25, 2024 •

edited

Loading

asyncapi-bot commented Nov 25, 2024 •

edited

Loading

coderabbitai bot left a comment

akshatnema Nov 25, 2024

dishafaujdar Nov 28, 2024

akshatnema Nov 29, 2024

akshatnema Nov 25, 2024

dishafaujdar Nov 26, 2024

akshatnema Nov 26, 2024

dishafaujdar Nov 26, 2024

devilkiller-ag commented Nov 28, 2024

akshatnema left a comment

This comment was marked as duplicate.

akshatnema commented Nov 29, 2024

fix: fix Spec Explorer link in Docs #3428

fix: fix Spec Explorer link in Docs #3428

Conversation

dishafaujdar commented Nov 25, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Nov 25, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

netlify bot commented Nov 25, 2024 • edited Loading

✅ Deploy Preview for asyncapi-website ready!

codecov bot commented Nov 25, 2024 • edited Loading

Codecov Report

asyncapi-bot commented Nov 25, 2024 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

akshatnema Nov 25, 2024

Choose a reason for hiding this comment

dishafaujdar Nov 28, 2024

Choose a reason for hiding this comment

akshatnema Nov 29, 2024

Choose a reason for hiding this comment

akshatnema Nov 25, 2024

Choose a reason for hiding this comment

dishafaujdar Nov 26, 2024

Choose a reason for hiding this comment

akshatnema Nov 26, 2024

Choose a reason for hiding this comment

dishafaujdar Nov 26, 2024

Choose a reason for hiding this comment

devilkiller-ag commented Nov 28, 2024

akshatnema left a comment

Choose a reason for hiding this comment

This comment was marked as duplicate.

akshatnema commented Nov 29, 2024

dishafaujdar commented Nov 25, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 25, 2024 •

edited

Loading

netlify bot commented Nov 25, 2024 •

edited

Loading

codecov bot commented Nov 25, 2024 •

edited

Loading

asyncapi-bot commented Nov 25, 2024 •

edited

Loading