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 placeholder links and metadata for missing tool details (#3810) #3869

Closed

Conversation

SURAJ-RATHI
Copy link

@SURAJ-RATHI SURAJ-RATHI commented Mar 11, 2025

Description:
This PR resolves inconsistencies in the Tools section where certain tools were missing essential metadata such as githubUrl, docsUrl, language, and tags.
Since I did not have the exact references, I have used dummy placeholder links as a temporary fix. Maintainers or contributors with knowledge of the correct details should replace them.

Problem:
Some tools had incomplete or false links.
Missing data resulted in cards displaying empty content in the UI.
The inconsistency led to an inconsistent user experience.
Fixes and Changes:
✅ Added placeholder links for githubUrl, docsUrl, tags, and languages.
✅ Ensured all tool cards display without missing content.
✅ Added inline comments in the config/tools.json file indicating that actual data should be updated.

Fix: #3810

How to Test:
Navigate to the Tools section in the deployed preview.
Verify that the previously empty or broken tool cards now contain placeholders.
Ensure maintainers replace dummy data with actual links and metadata.

Screenshot:
image

Summary by CodeRabbit

  • New Features
    • Enhanced filtering capabilities for API tracking tools by adding JavaScript as a selectable language option, allowing users to easily filter and find tools that support JavaScript.

Copy link
Contributor

coderabbitai bot commented Mar 11, 2025

Walkthrough

This commit updates the configuration in config/tools.json by modifying the language filters for two API tools. Both the "API Tracker - AsyncAPI specs" and "AsyncAPI-Directory by APIs.guru" tools now include a JavaScript filter with defined color and border color properties. This change enables users to filter these tools based on the JavaScript language.

Changes

File Change Summary
config/tools.json Updated the "language" filter for "API Tracker - AsyncAPI specs" and "AsyncAPI-Directory by APIs.guru" from an empty array to include a JavaScript object with color properties.

Suggested labels

autoapproved, autoupdate

Suggested reviewers

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

Poem

I hop through JSON fields so wide,
My ears perk up at a new config tide,
JavaScript now dances in filters with pride,
Colors and borders align in a fun design,
Celebrating code with a bunny’s joyful rhyme! 🐰


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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 Mar 11, 2025

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 93a880f
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67d03b765f65f70008fd23bc
😎 Deploy Preview https://deploy-preview-3869--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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Mar 11, 2025

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

 The subject "Added placeholder links and metadata for missing tool details (#3810)" found in the pull request title "fix: Added placeholder links and metadata for missing tool details (#3810)" should start with a lowercase character.

Copy link

codecov bot commented Mar 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9ceaf84) to head (93a880f).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3869   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines          667       667           
  Branches       113       113           
=========================================
  Hits           667       667           

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

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@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

🧹 Nitpick comments (2)
config/tools.json (2)

15-21: Improved Language Filter Metadata for "API Tracker - AsyncAPI specs"
The language filter now includes a JavaScript placeholder object with defined background and border color properties. This update ensures that the tool card doesn’t render blank language metadata in the UI. Please remember that these values are temporary placeholders and should be updated with accurate metadata when available.


110-116: Added Placeholder for Language Filter in "AsyncAPI-Directory by APIs.guru"
The previously empty language filter has now been populated with a JavaScript object featuring placeholder color settings. This change helps maintain a consistent UI by ensuring that each tool card displays valid metadata. Verify that similar updates have been applied wherever the metadata was previously missing.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9ceaf84 and 93a880f.

📒 Files selected for processing (1)
  • config/tools.json (1 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (4)
  • GitHub Check: Redirect rules - asyncapi-website
  • GitHub Check: Header rules - asyncapi-website
  • GitHub Check: Pages changed - asyncapi-website
  • GitHub Check: Lighthouse CI

Copy link
Collaborator

@TRohit20 TRohit20 left a comment

Choose a reason for hiding this comment

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

Hi @SURAJ-RATHI Thank you for your contribution and identifying this, but I don't think this is the right way to fix this inconsistency or issue, hence I am closing this PR.

Plus I don't see @sambhavgupta0705 actually approving the issue referenced, he was still waiting to hear a good fix before assigning it to someone, I'd recommend working with them on the issue and open a relevant PR then :)

@TRohit20 TRohit20 closed this Mar 11, 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] ### Title Card Data is Empty on AsyncAPI Website Tools section
3 participants