fix: fix Spec Explorer link in Docs

dishafaujdar commented 4 days ago

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.

coderabbitai[bot] commented 4 days ago

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

asyncapi/website#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.

Possibly related PRs

[#3294] - The changes in the GeneratorPage component involve CSS modifications that may relate to overall styling practices similar to the addition of the h-full class in the Calendar component, indicating a focus on layout consistency.
[#3327] - The update to the edit-page-config.json file involves correcting a link, which, while not directly related to the Calendar component, reflects a broader effort to ensure accurate resource linking and documentation, potentially impacting user experience in a similar context.

Suggested labels

ready-to-merge

Suggested reviewers

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

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! 🌟

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Reviewing files that changed from the base of the PR and between fb8444c32a8c9ce8f87e70551901f0657137f6bf and d2d76521c39ebf737b494647417ac556f571912d.

📒 Files selected for processing (1)

* `components/data/buckets.ts` (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

* components/data/buckets.ts

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

netlify[bot] commented 4 days ago

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
Latest commit	d2d76521c39ebf737b494647417ac556f571912d
Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67499edb43568e0008c99f84
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[bot] commented 4 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Please upload report for BASE (master@e56289b). Learn more about missing BASE report.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3428 +/- ## ========================================= Coverage ? 67.77% ========================================= Files ? 21 Lines ? 664 Branches ? 0 ========================================= Hits ? 450 Misses ? 214 Partials ? 0 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

asyncapi-bot commented 4 days ago

⚡️ Lighthouse report for the changes in this PR:	Category	Score
🔴 Performance	34
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

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

devilkiller-ag commented 1 day ago

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

asyncapi / website