Skip to content

Conversation

@asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Sep 1, 2025

Updated generator documentation is available and this PR introduces update to generator folder on the website

Summary by CodeRabbit

  • Documentation
    • Improved the “Baked-in templates” docs by converting a plain URL into a blockquoted, clickable markdown link for easier navigation.
    • Enhances readability and consistency within the documentation without altering content or behavior.
    • No functional changes to the product; this is a presentation/formatting update only.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 1, 2025

Walkthrough

Reformatted a documentation line in markdown/docs/tools/generator/baked-in-templates.md to use a blockquoted, clickable markdown link pointing to the baked-in templates list, replacing a plain URL. No content or functional changes, only presentation.

Changes

Cohort / File(s) Summary
Docs formatting
markdown/docs/tools/generator/baked-in-templates.md
Converted a plain URL to a blockquoted markdown link pointing to the same GitHub JSON list. No logic or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • thulieblack
  • TRohit20
  • quetzalliwrites
  • derberg

Poem

I nibbled the docs with gentle delight,
Turned a raw link into click-worthy light.
A hop, a bop, a tidy cite—
Now trails are clear for every byte.
Thump-thump! The path is bright. 🐇✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-generator-docs-e5e13d5475ea1a98166d6d3916f3c4449febdfd3

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit 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.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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
Copy link

netlify bot commented Sep 1, 2025

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit 7beea13
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/68b63d3fb8bb2a00087de527
😎 Deploy Preview https://deploy-preview-4372--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 project configuration.

@codecov
Copy link

codecov bot commented Sep 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (e296800) to head (7beea13).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #4372   +/-   ##
=========================================
  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 Author

asyncapi-bot commented Sep 1, 2025

⚡️ Lighthouse report for the changes in this PR:

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

Lighthouse ran on https://deploy-preview-4372--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: 0

🧹 Nitpick comments (1)
markdown/docs/tools/generator/baked-in-templates.md (1)

12-12: Use branch-agnostic permalink to avoid future link rot.

Replace blob/master with blob/HEAD so the link follows the repo’s default branch if it changes.

Apply this diff:

-> Check out the [list of baked-in templates](https://github.com/asyncapi/generator/blob/master/apps/generator/lib/templates/BakedInTemplatesList.json)
+> Check out the [list of baked-in templates](https://github.com/asyncapi/generator/blob/HEAD/apps/generator/lib/templates/BakedInTemplatesList.json).
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between b8e825f and 27b2204.

📒 Files selected for processing (1)
  • markdown/docs/tools/generator/baked-in-templates.md (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). (4)
  • GitHub Check: Automerge PR autoapproved by a bot
  • GitHub Check: Lighthouse CI
  • GitHub Check: Test NodeJS PR - windows-latest
  • GitHub Check: Test NodeJS PR - macos-13
🔇 Additional comments (1)
markdown/docs/tools/generator/baked-in-templates.md (1)

12-12: LGTM on formatting improvement.

Converting the raw URL to a descriptive, clickable link improves readability and accessibility.

@thulieblack
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 250823b into master Sep 2, 2025
23 of 24 checks passed
@asyncapi-bot asyncapi-bot deleted the update-generator-docs-e5e13d5475ea1a98166d6d3916f3c4449febdfd3 branch September 2, 2025 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants