Skip to content

Conversation

@GuillaumeGayot
Copy link
Contributor

@GuillaumeGayot GuillaumeGayot commented Oct 3, 2024

Description

by adding quotes we fix the highlighting of the markdown in the documentation

image

Related issue(s)

Resolve #3007

Summary by CodeRabbit

  • Documentation
    • Updated migration guide to AsyncAPI v3, highlighting significant breaking changes and new structures.
    • Clarified modifications to metadata, operations, and message handling in the new version.
    • Enhanced usability by simplifying parameters and security configurations.
    • Improved OAuth2 security scheme examples for clarity and consistency in the migration document.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@netlify
Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit c7656f2
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/68823ae107983c00088ea778
😎 Deploy Preview https://deploy-preview-3268--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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Oct 3, 2024

⚡️ Lighthouse report for the changes in this PR:

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

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

Walkthrough

The changes in this pull request update the migration documentation by correcting the OAuth2 security scheme examples. Specifically, the authorizationUrl values and scope keys in the AsyncAPI v2 and v3 snippets are now enclosed in quotes to fix formatting and highlighting issues.

Changes

File Path Change Summary
markdown/docs/migration/migrating-to-v3.md Quoted authorizationUrl values and OAuth2 scope keys (write:pets, read:pets) in security scheme examples for consistent formatting.

Assessment against linked issues

Objective Addressed Explanation
Fix highlighting errors in migration docs (#3007) Quoting strings in OAuth2 examples resolves the highlighting issues in the migration documentation.

Possibly related PRs

  • test: add markdown tests #3301: This PR adds markdown tests that could help ensure the accuracy of the changes made in the main PR regarding the structure and content of markdown files, particularly in the context of the AsyncAPI v3 migration documentation.

Suggested labels

ready-to-merge

Suggested reviewers

  • sambhavgupta0705
  • TRohit20
  • quetzalliwrites
  • asyncapi-bot-eve

🐰
In docs where code once hid,
Quotes now show what’s what, no skid.
OAuth flows in tidy strings,
Highlighting fixed, joy it brings!
Hop along, the change is neat,
Migration docs now look complete! 🌿

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c17c142 and 34cfbb3.

📒 Files selected for processing (1)
  • markdown/docs/migration/migrating-to-v3.md (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • markdown/docs/migration/migrating-to-v3.md
⏰ 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
✨ Finishing Touches
🧪 Generate unit tests
  • 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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

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

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests 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.

@codecov
Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f7e20cd) to head (c7656f2).
Report is 1 commits behind head on master.

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

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4f813d0 and c17c142.

📒 Files selected for processing (1)
  • markdown/docs/migration/migrating-to-v3.md (2 hunks)
🔇 Additional comments (1)
markdown/docs/migration/migrating-to-v3.md (1)

268-271: Changes align with PR objectives.

The indentation fixes in both v2 and v3 OAuth examples will help ensure proper markdown highlighting, which aligns with the PR's objective of fixing highlighting issues in the documentation.

Also applies to: 294-297

@sambhavgupta0705
Copy link
Member

@GuillaumeGayot can you please add the docs prefix in the title

@sambhavgupta0705
Copy link
Member

/update

@sambhavgupta0705 sambhavgupta0705 added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Dec 31, 2024
@sambhavgupta0705
Copy link
Member

@TRohit20 have a look please

@thulieblack thulieblack changed the title fix(migrating-to-v3): fix mark down to ensure correct highlighting docs: fix mark down to ensure correct highlighting Jul 24, 2025
@thulieblack thulieblack self-requested a review as a code owner July 24, 2025 13:36
@thulieblack
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 64b04c8 into asyncapi:master Jul 24, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs ready-to-merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[📑 Docs]: Specs' hightlighting error

5 participants