docs: update reference links in the asyncapi structure doc #4337
Conversation
bandantonio
requested review from
TRohit20,
asyncapi-bot-eve and
thulieblack
as code owners
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughFormatting-only edits to a single docs page: the bullet list of reference links in markdown/docs/concepts/asyncapi-document/structure.md switches from "-" to "+" markers. No content, links, or semantics changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4337 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4337--asyncapi-website.netlify.app/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
markdown/docs/concepts/asyncapi-document/structure.md (1)
425-447: Optional: consider pinning to a stable spec version instead of “latest”.Linking to “latest” can break anchors in the future if headings/IDs change. If the website supports stable version aliases (for example, v3 or a specific version), consider pinning these references to reduce maintenance churn. If you prefer “latest” for freshness, keep as-is.
If you confirm the preferred version alias, I can provide a one-shot diff to update all definitions consistently.
📜 Review details
Configuration used: .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.
📒 Files selected for processing (1)
markdown/docs/concepts/asyncapi-document/structure.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-07-19T20:58:34.040Z
Learnt from: bandantonio
PR: asyncapi/website#4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Applied to files:
markdown/docs/concepts/asyncapi-document/structure.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). (2)
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Lighthouse CI
🔇 Additional comments (2)
markdown/docs/concepts/asyncapi-document/structure.md (2)
425-448: Good fix: adding explicit reference definitions removes empty bullets and restores links.Defining all link reference labels at the bottom is the right way to resolve the stray empty bullet list reported in #4307. The label names match their usages throughout the doc, and the targets consistently point to the spec “latest” page.
431-431: Keep as-is — the spec exposes #operationObject (no #operationItemObject).I checked https://www.asyncapi.com/docs/reference/specification/latest — the page contains id="operationObject" and no id="operationItemObject", so the current link is correct.
- File: markdown/docs/concepts/asyncapi-document/structure.md — line ~431
- Keep: [operation-item-object]: /docs/reference/specification/latest#operationObject
Likely an incorrect or invalid review comment.
|
/rtm |
3 participants
Description
Fix for the broken reference links that appear as empty bullet points on the AsyncAPI document structure page
Related issue(s)
Fixes #4307
Summary by CodeRabbit