-
-
Notifications
You must be signed in to change notification settings - Fork 667
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
base: master
Are you sure you want to change the base?
Conversation
WalkthroughThe pull request introduces two main changes: the Changes
Possibly related issues
Suggested labels
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
We require all PRs to follow Conventional Commits specification.
|
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3428--asyncapi-website.netlify.app/ |
There was a problem hiding this 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 usingborder-orange-200
while the background usesbg-teal-200
. For consistency, consider usingborder-teal-200
instead.className: 'bg-teal-200', - borderClassName: 'border-orange-200', + borderClassName: 'border-teal-200',
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
⛔ 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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah sure
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
Bug Fixes