docs(react): rewrite @see URLs as markdown links#3421
Merged
kumilingus merged 1 commit intoJul 7, 2026
Conversation
Bare @see URLs rendered with the path tail as link text (Paper#wakeUp) in the generated API reference, and the #wakeUp anchor didn't match the lowercase Docusaurus slug. Markdown links give readable text and correct anchors; the docs converter preserves both.
kumilingus
approved these changes
Jul 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bare
@see https://docs.jointjs.com/...URLs in joint-react TSDoc render poorly in the generated API reference: the docs converter falls back to the URL path tail as link text (Paper#wakeUp), and the#wakeUpanchor doesn't match the lowercase Docusaurus slug, so the link lands nowhere.Rewrites all 7 bare
@seeURLs as markdown links with code-styled, human-readable text (e.g.[paper.wakeUp()](https://docs.jointjs.com/api/dia/Paper#wakeup)) and fixes the anchor casing. The converter in joint-docs preserves author link text, so the API reference picks these up on the next regeneration (already verified end to end).Touched:
use-paper.ts,paper.types.ts,graph-provider.tsx— TSDoc comments only, no runtime changes.🤖 Generated with Claude Code