Skip to content

[docs-theme] Fix broken @see links in props interface tables#7832

Open
dhruv7539 wants to merge 3 commits intopalantir:developfrom
dhruv7539:codex/fix-see-tag-links-6553
Open

[docs-theme] Fix broken @see links in props interface tables#7832
dhruv7539 wants to merge 3 commits intopalantir:developfrom
dhruv7539:codex/fix-see-tag-links-6553

Conversation

@dhruv7539
Copy link

Summary

  • update SeeTag to render HTTP(S) values from @see as clickable anchor links
  • add support for JSDoc {@link ...} syntax inside @see values
  • preserve existing type-rendering behavior as fallback for non-link values

Why

Fixes #6553. In props interface tables, many @see tags are URL references, but they were being rendered through renderType(...), which is intended for TypeScript type expressions.

Validation

  • pnpm nx compile @blueprintjs/docs-theme
  • pnpm nx compile @blueprintjs/eslint-plugin
  • pnpm nx lint @blueprintjs/docs-theme

(Executed with Node v22.14.0; repository prints an engine warning because it currently prefers Node >=24.11.0.)

@palantirtech
Copy link
Member

Thanks for your interest in palantir/blueprint, @dhruv7539! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

@changelog-app
Copy link

changelog-app bot commented Feb 27, 2026

Generate changelog in packages/docs-theme/changelog/@unreleased

Type (Select exactly one)

  • Feature (Adding new functionality)
  • Improvement (Improving existing functionality)
  • Fix (Fixing an issue with existing functionality)
  • Break (Creating a new major version by breaking public APIs)
  • Deprecation (Removing functionality in a non-breaking way)
  • Migration (Automatically moving data/functionality to a new system)

Description

[docs-theme] Fix broken @see links in props interface tables

Check the box to generate changelog(s)

  • Generate changelog entry

@dhruv7539
Copy link
Author

Addressed the changelog bot request in the latest push (36af5b9e7):

  • added packages/docs-theme/changelog/@unreleased/pr-7832.v2.yml
  • marked this as a fix with a link back to this PR

@dhruv7539
Copy link
Author

/changelog

packages/docs-theme/changelog/@unreleased

  • Feature (Adding new functionality)
  • Improvement (Improving existing functionality)
  • Fix (Fixing an issue with existing functionality)
  • Break (Creating a new major version by breaking public APIs)
  • Deprecation (Removing functionality in a non-breaking way)
  • Migration (Automatically moving data/functionality to a new system)
Fix broken @see links in props interface tables
  • Generate changelog entry

@changelog-app
Copy link

changelog-app bot commented Feb 27, 2026

Successfully generated changelog entry!

Need to regenerate?

Simply interact with the changelog bot comment again to regenerate these entries.


📋Changelog Preview

🐛 Fixes

  • Fix broken @see links in props interface tables (#7832)

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.

BP doc's @see links in props interface tables are broken

2 participants