Enable readme auto-generation for DataTableManager

[kark]

Summary

This PR enables auto-generation of the readme file for <DataTableManager> component

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: 82cb7dae50c34c4c0c24d792bd4ed992150c930a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 92 packages

Name	Type
@commercetools-local/generator-readme	Patch
@commercetools-uikit/data-table-manager	Patch
@commercetools-frontend/ui-kit	Patch
@commercetools-uikit/design-system	Patch
@commercetools-uikit/calendar-time-utils	Patch
@commercetools-uikit/calendar-utils	Patch
@commercetools-uikit/hooks	Patch
@commercetools-uikit/i18n	Patch
@commercetools-uikit/localized-utils	Patch
@commercetools-uikit/utils	Patch
@commercetools-uikit/accessible-hidden	Patch
@commercetools-uikit/avatar	Patch
@commercetools-uikit/card	Patch
@commercetools-uikit/collapsible-motion	Patch
@commercetools-uikit/collapsible-panel	Patch
@commercetools-uikit/collapsible	Patch
@commercetools-uikit/constraints	Patch
@commercetools-uikit/data-table	Patch
@commercetools-uikit/field-errors	Patch
@commercetools-uikit/field-label	Patch
@commercetools-uikit/grid	Patch
@commercetools-uikit/icons	Patch
@commercetools-uikit/label	Patch
@commercetools-uikit/link	Patch
@commercetools-uikit/loading-spinner	Patch
@commercetools-uikit/messages	Patch
@commercetools-uikit/notifications	Patch
@commercetools-uikit/pagination	Patch
@commercetools-uikit/primary-action-dropdown	Patch
@commercetools-uikit/stamp	Patch
@commercetools-uikit/tag	Patch
@commercetools-uikit/text	Patch
@commercetools-uikit/tooltip	Patch
@commercetools-uikit/view-switcher	Patch
@commercetools-uikit/accessible-button	Patch
@commercetools-uikit/flat-button	Patch
@commercetools-uikit/icon-button	Patch
@commercetools-uikit/link-button	Patch
@commercetools-uikit/primary-button	Patch
@commercetools-uikit/secondary-button	Patch
@commercetools-uikit/secondary-icon-button	Patch
@commercetools-uikit/async-creatable-select-field	Patch
@commercetools-uikit/async-select-field	Patch
@commercetools-uikit/creatable-select-field	Patch
@commercetools-uikit/date-field	Patch
@commercetools-uikit/date-range-field	Patch
@commercetools-uikit/date-time-field	Patch
@commercetools-uikit/localized-multiline-text-field	Patch
@commercetools-uikit/localized-text-field	Patch
@commercetools-uikit/money-field	Patch
@commercetools-uikit/multiline-text-field	Patch
@commercetools-uikit/number-field	Patch
@commercetools-uikit/password-field	Patch
@commercetools-uikit/radio-field	Patch
@commercetools-uikit/search-select-field	Patch
@commercetools-uikit/select-field	Patch
@commercetools-uikit/text-field	Patch
@commercetools-uikit/time-field	Patch
@commercetools-uikit/async-creatable-select-input	Patch
@commercetools-uikit/async-select-input	Patch
@commercetools-uikit/checkbox-input	Patch
@commercetools-uikit/creatable-select-input	Patch
@commercetools-uikit/date-input	Patch
@commercetools-uikit/date-range-input	Patch
@commercetools-uikit/date-time-input	Patch
@commercetools-uikit/input-utils	Patch
@commercetools-uikit/localized-money-input	Patch
@commercetools-uikit/localized-multiline-text-input	Patch
@commercetools-uikit/localized-rich-text-input	Patch
@commercetools-uikit/localized-text-input	Patch
@commercetools-uikit/money-input	Patch
@commercetools-uikit/multiline-text-input	Patch
@commercetools-uikit/number-input	Patch
@commercetools-uikit/password-input	Patch
@commercetools-uikit/radio-input	Patch
@commercetools-uikit/rich-text-input	Patch
@commercetools-uikit/rich-text-utils	Patch
@commercetools-uikit/search-select-input	Patch
@commercetools-uikit/select-input	Patch
@commercetools-uikit/select-utils	Patch
@commercetools-uikit/text-input	Patch
@commercetools-uikit/time-input	Patch
@commercetools-uikit/toggle-input	Patch
@commercetools-uikit/spacings-inline	Patch
@commercetools-uikit/spacings-inset-squish	Patch
@commercetools-uikit/spacings-inset	Patch
@commercetools-uikit/spacings-stack	Patch
@commercetools-uikit/buttons	Patch
@commercetools-uikit/fields	Patch
@commercetools-uikit/inputs	Patch
@commercetools-uikit/spacings	Patch
visual-testing-app	Patch

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

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
ui-kit	✅ Ready (Inspect)	Visit Preview	Aug 25, 2022 at 3:26PM (UTC)

[CarlosCortizasCT]

It seems columns signature renders a little bloated. Is there anything we can do to render it more clear as the others?

[kark]

It seems columns signature renders a little bloated. Is there anything we can do to render it more clear as the others?

Thanks, this is definitely a valid point, since it's a change definitely for the worse.

I started fixing that, but it seems the storybook-readme strorybook add-on has real problems with parsing and properly displaying markdown code block with jsdoc comments. I guess it's doable if we add enough str.replace()s (also changing the way the READMEs are displayed in GitHub), but I honestly feel this is waste of time considering we are anyway thinking about displaying those interfaces in a table for better readability.

So my conclusion here is to wait with this PR (perhaps close it) until work on the mentioned task can be included here.

[CarlosCortizasCT]

It seems columns signature renders a little bloated. Is there anything we can do to render it more clear as the others?

Thanks, this is definitely a valid point, since it's a change definitely for the worse.

I started fixing that, but it seems the storybook-readme strorybook add-on has real problems with parsing and properly displaying markdown code block with jsdoc comments. I guess it's doable if we add enough str.replace()s (also changing the way the READMEs are displayed in GitHub), but I honestly feel this is waste of time considering we are anyway thinking about displaying those interfaces in a table for better readability.

So my conclusion here is to wait with this PR (perhaps close it) until work on the mentioned task can be included here.

I agree 👍