Skip to content

Fix missing component descriptions#359

Merged
quietbits merged 2 commits intomainfrom
fix-comp-description
Mar 19, 2026
Merged

Fix missing component descriptions#359
quietbits merged 2 commits intomainfrom
fix-comp-description

Conversation

@quietbits
Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings March 18, 2026 19:25
@socket-security
Copy link
Copy Markdown

socket-security bot commented Mar 18, 2026

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updated@​types/​react@​18.2.73 ⏵ 19.2.14100 +11007992100

View full report

package.json Outdated
Comment on lines +30 to +31
"@types/react": "^19",
"@types/react-dom": "^19"
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added these to fix TS errors because Docusaurus uses older @types/react version which has JSX.Element as component type.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR addresses missing component description rendering in the design-system website by improving how Typedoc comment summaries are discovered, alongside dependency/type resolution updates to keep React typings consistent across the workspace.

Changes:

  • Update ComponentDescription to fall back to signature-level comments when declaration-level comments are missing.
  • Add workspace-level resolutions for @types/react and @types/react-dom.
  • Refresh yarn.lock and bump @types/react in the design-system package.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File Description
yarn.lock Lockfile updates reflecting updated/normalized dependency graph and React type alignment.
package.json Adds root-level resolutions for React type packages.
@stellar/design-system/package.json Bumps @types/react devDependency patch version.
@stellar/design-system-website/src/components/ComponentDescription/index.tsx Fixes description lookup by using declaration or signature comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@stellar-jenkins
Copy link
Copy Markdown

1 similar comment
@stellar-jenkins
Copy link
Copy Markdown

@quietbits quietbits requested a review from jeesunikim March 18, 2026 19:40
@quietbits quietbits merged commit 52592b6 into main Mar 19, 2026
6 checks passed
@quietbits quietbits deleted the fix-comp-description branch March 19, 2026 12:19
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.

4 participants