Skip to content

Link: sync docs.json with component API#8181

Open
siddharthkp wants to merge 1 commit into
mainfrom
siddharthkp/link-docs-hovercolor-underline
Open

Link: sync docs.json with component API#8181
siddharthkp wants to merge 1 commit into
mainfrom
siddharthkp/link-docs-hovercolor-underline

Conversation

@siddharthkp

@siddharthkp siddharthkp commented Jul 17, 2026

Copy link
Copy Markdown
Member

Link.docs.json still mentions underline prop which was removed from the component in v38. It also does not have a deprecated key for hoverColor. Fixed both.

Rollout strategy

  • None; documentation metadata only, no runtime or published API change.

Mark hoverColor as deprecated and remove the removed underline prop
@siddharthkp siddharthkp added the skip changeset This change does not need a changelog label Jul 17, 2026
@changeset-bot

changeset-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 020a6da

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

@github-actions github-actions Bot added the staff Author is a staff member label Jul 17, 2026
@siddharthkp
siddharthkp marked this pull request as ready for review July 17, 2026 12:06
@siddharthkp
siddharthkp requested a review from a team as a code owner July 17, 2026 12:06
@siddharthkp
siddharthkp requested review from TylerJDev and Copilot July 17, 2026 12:06
@siddharthkp siddharthkp added the integration-tests: skipped manually Changes in this PR do not require an integration test label Jul 17, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Link documentation metadata so it matches the current component API and deprecation status, ensuring generated docs don’t advertise removed props or miss deprecation warnings.

Changes:

  • Removed the stale underline prop from Link.docs.json (prop no longer exists on the component).
  • Marked hoverColor as deprecated in Link.docs.json and updated its description to steer consumers to CSS modules.
Show a summary per file
File Description
packages/react/src/Link/Link.docs.json Removes outdated prop metadata and adds a deprecation flag for hoverColor to align docs with the component API.

Review details

  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Low

Comment thread packages/react/src/Link/Link.docs.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integration-tests: skipped manually Changes in this PR do not require an integration test skip changeset This change does not need a changelog staff Author is a staff member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants