Skip to content

Conversation

@Harsh-Sahu43
Copy link

This PR converts markdown anchors and their internal references from camelCase to kebab-case to restore GitHub navigation behavior.

Changes are limited to anchor names and references only. No content or semantics were modified.

Fixes #1144

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.

@char0n
Copy link
Member

char0n commented Dec 16, 2025

Hi @Harsh-Sahu43,

Thanks a lot for the work! We're review the changes ASAP.

@Harsh-Sahu43
Copy link
Author

Thanks a lot for the quick response, @char0n.
I’m happy to clarify any part of the change or make adjustments if needed. Looking forward to the review.

@derberg
Copy link
Member

derberg commented Dec 18, 2025

@Harsh-Sahu43 please also open a PR in the website (write it is just a draft for this PR) and edit https://github.com/asyncapi/website/blob/master/markdown/docs/reference/specification/v3.0.0.md with the new version you worked on (removed ## Table of Contents as in website it is built separately). I just want to make sure we don't have any special magic in website that will stop working because of this PR. You PR in website will get a preview link where you can go and see if right-hand side navigation works

@Harsh-Sahu43
Copy link
Author

Thanks @derberg for the review and guidance.

I’ve opened a draft PR in asyncapi/website to validate the kebab-case anchor
changes against the website rendering. All markdown and MDX checks pass, and
the Netlify preview fails during Next.js prerendering with a runtime
ReferenceError (channelId is not defined), which appears unrelated to the
anchor updates or TOC removal.

If you think it would be helpful, I’m happy to investigate this website-side
issue further or assist in isolating it. Please let me know how you’d like me
to proceed.

@derberg derberg changed the title fix(spec): convert markdown anchors to kebab-case docs: convert markdown anchors to kebab-case Dec 23, 2025
@derberg
Copy link
Member

derberg commented Dec 23, 2025

changes in your draft pr in website are not the same as in this PR

logs

9:45:10 PM: ReferenceError: channelId is not defined
9:45:10 PM:     at h (.next/server/pages/docs/reference/specification/v3.0.0.js:1:47074)
9:45:10 PM:     at i (.next/server/pages/docs/reference/specification/v3.0.0.js:1:222376)
9:45:10 PM: Error occurred prerendering page "/docs/reference/specification/v3.0.0". Read more: https://nextjs.org/docs/messages/prerender-error
9:45:10 PM: ReferenceError: channelId is not defined

you made modification to {channelId} by removing \ escape char

@sonarqubecloud
Copy link

@Harsh-Sahu43
Copy link
Author

I have updated the PR to restore the escaped literal {channelId}. The anchor updates in this PR are now fully aligned with asyncapi/website#4738. A new Deploy Preview should reflect the fix once the build completes.

Please let me know if you would like any further adjustments.

@derberg
Copy link
Member

derberg commented Jan 15, 2026

@Harsh-Sahu43 please check your PR in website again, the preview is still not available

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.

Anchors in markdown spec no longer work in GitHub navigation

3 participants