Skip to content

chore: update assets#1751

Closed
asyncapi-bot wants to merge 1 commit intomasterfrom
assets-update/@asyncapi/generator-components@0.3.1
Closed

chore: update assets#1751
asyncapi-bot wants to merge 1 commit intomasterfrom
assets-update/@asyncapi/generator-components@0.3.1

Conversation

@asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Nov 12, 2025

Updating assets like for example API.md, but not only, that shoudl be generated and not manually updated

Summary by CodeRabbit

  • Documentation
    • Improved formatting in API documentation for template-related sections.

@changeset-bot
Copy link

changeset-bot bot commented Nov 12, 2025

⚠️ No Changeset found

Latest commit: b87773b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link

coderabbitai bot commented Nov 12, 2025

Walkthrough

This pull request adjusts HTML tag formatting in the API documentation. Specifically, the closing </dd> tag in the listBakedInTemplates section is repositioned to its own line, while the </p> tag remains on the preceding line. No functional or semantic changes to the documentation content.

Changes

Cohort / File(s) Summary
Documentation formatting
apps/generator/docs/api.md
Adjusted closing HTML tag placement in listBakedInTemplates section: moved </dd> to its own line for improved formatting consistency

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

This is a minor documentation formatting adjustment with no functional impact.

Possibly related PRs

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'chore: update assets' is vague and overly generic, not clearly indicating the specific change to documentation formatting. Consider a more specific title that reflects the actual change, such as 'chore: update generated API documentation' or 'docs: reformat API.md documentation'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch assets-update/@asyncapi/generator-components@0.3.1

📜 Recent 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 1a5ad6c and b87773b.

📒 Files selected for processing (1)
  • apps/generator/docs/api.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: derberg
Repo: asyncapi/generator PR: 1551
File: apps/generator/docs/generator-template.md:45-73
Timestamp: 2025-05-12T14:23:48.919Z
Learning: AsyncAPI 3.0.0 specification introduces significant structural changes from 2.x:
1. Operations become top-level elements with references to channels
2. Channels use 'address' for the topic path instead of having nested publish/subscribe
3. Messages are defined under a 'messages' container in channels
4. Servers can use a 'host' property
Learnt from: derberg
Repo: asyncapi/generator PR: 1551
File: apps/generator/docs/generator-template.md:45-73
Timestamp: 2025-05-12T14:23:48.919Z
Learning: AsyncAPI 3.0.0 specification introduces significant structural changes from 2.x:
1. Operations become top-level elements with action property (send/receive) and references to channels
2. Channels use 'address' for the topic path instead of having nested publish/subscribe operations
3. Messages are defined under a 'messages' container in channels
4. The specification decouples operations, channels and messages to improve reusability
5. Servers can use a 'host' property
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
  • GitHub Check: Automerge PR autoapproved by a bot
  • GitHub Check: Acceptance tests for generated templates
  • GitHub Check: Test generator as dependency with Node 20
  • GitHub Check: Test generator as dependency with Node 18
  • GitHub Check: Test NodeJS PR - macos-13
  • GitHub Check: Test NodeJS PR - ubuntu-latest
  • GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (1)
apps/generator/docs/api.md (1)

17-21: Auto-generated documentation formatting update — LGTM.

The closing </dd> tag repositioning is a minor whitespace/formatting normalization in the auto-generated API documentation. No semantic or content changes.

Since this is an asset regeneration PR, confirm that this formatting change reflects the current output of the documentation generator (e.g., version update of @asyncapi/generator-components or generator configuration).


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.

@sonarqubecloud
Copy link

@derberg derberg closed this Nov 12, 2025
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.

3 participants