Skip to content

Conversation

derberg
Copy link
Member

@derberg derberg commented Oct 16, 2025

WIP DON'T REVIEW YET

TODO:

  • companies content details
  • $ref pointers between use case and company
  • script to dereference and make ready for reading in UI

@Shriya-Chauhan yo, this is the content I promised. I started it during my flight, now polishing

Summary by CodeRabbit

  • New Features
    • Added a structured catalog of AsyncAPI use cases (infra-as-code, testing, docs, governance, self-service, codegen, extensibility) with descriptions and linked data entries.
  • Chores
    • Removed the public adopters dataset and all associated adopter entries and resource links.

Copy link

netlify bot commented Oct 16, 2025

Deploy Preview for asyncapi-website failed.

Name Link
🔨 Latest commit 34506bb
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/68f1ef005ccfba000897a9d4

Copy link
Contributor

coderabbitai bot commented Oct 16, 2025

Walkthrough

Adds a new YAML configuration file config/usecases.yaml defining AsyncAPI use cases and a catalog of organizations; removes the existing config/adopters.yml file containing adopter entries and their resources. Data contains several incomplete or inconsistent fields.

Changes

Cohort / File(s) Summary
New use cases & data
config/usecases.yaml
Adds a new structured YAML file with seven use case entries (infraascode, testing, docs, governance, selfservice, codegen, extensibility) and a data section listing ~20 organizations with fields: name, description, type, url. Several entries have missing/placeholder values and inconsistent formatting.
Removed adopters dataset
config/adopters.yml
Deletes the entire adopters dataset file and all contained adopter entries/resources (multiple company blocks and linked resources). No replacement content provided.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • akshatnema
  • sambhavgupta0705
  • anshgoyalevil
  • Mayaleeeee

Poem

🐰 I hopped through YAML rows tonight,

Adding use cases, names in sight,
Some links still sleep, some texts ask care,
A tidy hop — I left a hare,
For devs to prune and make it right.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title "chore: add content with case studies" is partially related to the changeset. The title accurately describes the addition of a new usecases.yaml configuration file that introduces a structured catalog of AsyncAPI use cases and associated organization/company data entries. However, the title doesn't capture the full scope of the changes, as the PR also removes the entire adopters.yml file with its 15 adopter entries. The organizations listed in the new usecases.yaml file appear to correspond to those previously in adopters.yml, suggesting this is a data reorganization. Despite this omission, the title does refer to a real and significant aspect of the change—the addition of new case study content in a structured format, which appears to be the primary objective based on the PR description.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

codecov bot commented Oct 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (9de49c1) to head (34506bb).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #4486   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          778       778           
  Branches       144       144           
=========================================
  Hits           778       778           

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

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Oct 16, 2025

⚡️ Lighthouse report for the changes in this PR:

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

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

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: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9de49c1 and 492bce4.

📒 Files selected for processing (1)
  • config/usecases.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Test NodeJS PR - macos-13
  • GitHub Check: Test NodeJS PR - windows-latest
  • GitHub Check: Lighthouse CI

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: 1

🧹 Nitpick comments (1)
config/usecases.yaml (1)

105-114: Normalize content type field values.

Adeo (line 108) and HDI Global (line 113) use the type Use Case, which differs stylistically from other entries (Video, Slides, Article, Docs, Code). For consistency and downstream parsing, consider renaming to a standard type or documenting the full list of allowed values.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 492bce4 and 34506bb.

📒 Files selected for processing (2)
  • config/adopters.yml (0 hunks)
  • config/usecases.yaml (1 hunks)
💤 Files with no reviewable changes (1)
  • config/adopters.yml
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (2)
config/usecases.yaml (2)

50-59: Verify duplicate URL for Walmart and eBay.

Walmart (line 54) and eBay (line 59) both reference the same YouTube URL: https://www.youtube.com/watch?v=SxTpGRaNIPo. Confirm whether this is intentional or a copy-paste error. If incorrect, correct the eBay entry.


1-23: Approved: Use cases section is well-structured.

The use cases are clearly defined with consistent formatting and meaningful descriptions. The governance spelling is now correct.

Comment on lines +100 to +104
schwarz:
name: Schwarz Group
description: TODO
type: Video
url: TODO
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Complete TODO entries before merge.

The Schwarz Group (lines 100–104) and SAP (line 119) entries contain placeholder TODO text. Either fill in the data or remove incomplete entries.

Also applies to: 115-119

🤖 Prompt for AI Agents
In config/usecases.yaml around lines 100–104 and 115–119, the entries for
Schwarz Group and SAP contain placeholder "TODO" values for description and url;
replace the TODOs with accurate description, type, and url information (or
remove the entire incomplete entry) so no placeholder text remains—ensure each
usecase has a proper name, non-empty description, valid type, and a reachable
url, and validate YAML formatting after edits.

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.

2 participants