New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: component type docs (a-c) #3505
Conversation
Run & review this pull request in StackBlitz Codeflow. |
🦋 Changeset detectedLatest commit: be2d11d The changes in this PR will be included in the next version bump. This PR includes changesets to release 20 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for paste-theme-designer ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
☁️ Nx Cloud ReportCI is running/has finished running commands for commit be2d11d. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
✅ Deploy Preview for paste-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit be2d11d:
|
Passing run #6913 ↗︎
Details:
Review all test suite changes for PR #3505 ↗︎ |
Size Change: -44 B (0%) Total Size: 1 MB
ℹ️ View Unchanged
|
ef8bd4c
to
dc24e0d
Compare
dc24e0d
to
d767353
Compare
d767353
to
0aee70f
Compare
424753a
to
380be58
Compare
packages/paste-website/src/components/site-wrapper/sidebar/SidebarNavigation.tsx
Show resolved
Hide resolved
packages/paste-website/src/pages/components/account-switcher/api.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue: A whole bunch of inherited props on AccountSwitcher, AccountSwitcherItem, AccountSwitcherRadio, AccountSwitcherBadge show up as required. Not sure if they all actually are and the value also gets inherited from somewhere else, but it's mainly just kinda unexpected to see required props hidden away.
'@twilio-paste/code-block': patch | ||
'@twilio-paste/core': patch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can merge a lot of these changesets into a single one, with the same message:
ie:
---
'@twilio-paste/code-block': patch
'@twilio-paste/chat-log': patch
'@twilio-paste/core': patch
---
Improved TsDoc type annotations
The benefit is, I suspect, it wont bump core 10+ times
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'll only bump it once, it rolls core up into a single minor or patch. The advantage here is that you get a package level dedicated changelog entry. So you're not sharing a single changelog entry for multiple packages, making the package changelog much more isolated and specific to that package only.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to know
packages/paste-core/components/button-group/src/ButtonGroup.tsx
Outdated
Show resolved
Hide resolved
* @memberof AvatarProps | ||
*/ | ||
element?: BoxProps["element"]; | ||
}; | ||
|
||
export type AvatarContentProps = { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this one is an exported component, but it is appearing on the docsite
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I exported it because we use it in the user-dialog package but yeah it's not ideal on the docs site
Components A-C