Skip to content

docs: migrate jsdoc - #2482

Merged
bennypowers merged 73 commits into
mainfrom
docs/migrate-jsdoc
Jul 24, 2025
Merged

docs: migrate jsdoc#2482
bennypowers merged 73 commits into
mainfrom
docs/migrate-jsdoc

Conversation

@bennypowers

@bennypowers bennypowers commented Jul 18, 2025

Copy link
Copy Markdown
Member

What I did

  1. migrate jsdoc @csspart and @slot to html comments

Notes to Reviewers

what we're looking to see here is that the manifest is basically the same as or better than main

for after #2455

one improvement we already got: deprecated flag for cssprops:


# Deprecations
<root>
├─┬module rh-navigation-secondary/rh-navigation-secondary-overlay.js
│ └─┬<rh-navigation-secondary-overlay>
│   └─┬CSS Properties
│     └──--rh-secondary-nav-overlay-z-index (DEPRECATED: use --rh-navigation-secondary-overlay-z-index) 
└─┬module rh-tooltip/rh-tooltip.js
  └─┬<rh-tooltip>
    └─┬CSS Properties
      ├──--rh-tooltip__arrow--Width (DEPRECATED: use --rh-tooltip-arrow-size) 
      ├──--rh-tooltip--MaxWidth (DEPRECATED: use --rh-tooltip-max-width) 
      ├──--rh-tooltip__content--PaddingTop (DEPRECATED: use --rh-tooltip-content-padding-block-start) 
      ├──--rh-tooltip__content--PaddingBottom (DEPRECATED: use --rh-tooltip-content-padding-block-end) 
      ├──--rh-tooltip__content--PaddingLeft (DEPRECATED: use --rh-tooltip-content-padding-inline-start) 
      ├──--rh-tooltip__content--PaddingRight (DEPRECATED: use --rh-tooltip-content-padding-inline-end) 
      ├──--rh-tooltip__content--FontSize (DEPRECATED: use --rh-tooltip-content-font-size) 
      ├──--rh-tooltip__content--Color (DEPRECATED: use --rh-tooltip-content-color) 
      └──--rh-tooltip__content--BackgroundColor (DEPRECATED: use --rh-tooltip-content-background-color) 

@changeset-bot

changeset-bot Bot commented Jul 18, 2025

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4e465d2

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

Comment thread elements/rh-tag/rh-tag.ts
Comment thread elements/rh-tag/rh-tag.ts

@zeroedin zeroedin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Labelled Guides Teach Meaning

@adamjohnson adamjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Found a few more edge cases. 😇

Comment thread elements/rh-navigation-secondary/rh-navigation-secondary.css Outdated
Comment thread elements/rh-navigation-secondary/rh-navigation-secondary-menu.css Outdated
Comment thread elements/rh-navigation-secondary/rh-navigation-secondary-menu.css Outdated
Comment thread elements/rh-pagination/rh-pagination.css
Comment thread elements/rh-skip-link/rh-skip-link.ts Outdated
Comment thread elements/rh-tabs/rh-tab.css Outdated
Comment thread elements/rh-tooltip/rh-tooltip.css

@adamjohnson adamjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Line-by-line Guidance, Thoughtfully Moved

@bennypowers
bennypowers merged commit e41498c into main Jul 24, 2025
8 checks passed
@bennypowers
bennypowers deleted the docs/migrate-jsdoc branch July 24, 2025 18:53
@github-project-automation github-project-automation Bot moved this from Review 🔍 to Done ☑️ in Red Hat Design System Jul 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done ☑️

Development

Successfully merging this pull request may close these issues.

3 participants