docs: add disclaimer to address Storybook bug (wrong type in sd-carousel variant)

[Vahid1919]

Description:

This bug arises due to Storybook interpreting the option name "number" as a type, even though we manually describe the type as a String. Changing the name resolves this issue, but making a breaking change for a Storybook issue is not viable.

Since this is not related to the component, I added a disclaimer to inform users of this issue. Closes #1249

Definition of Reviewable:

• Documentation is created/updated

• Stories (features, a11y) are created/updated
• relevant tickets are linked

[mariohamann]

This might be resolved, when we update and Storybook, move over to the current version of wc-storybook-helpers and apply a patch we already have at Synergy: https://github.com/synergy-design-system/synergy-design-system/blob/69f8e7a12a6f5d21ff0c84cde56c95f48508b72c/patches/wc-storybook-helpers%401.5.3.patch#L33

cc @smfonseca

[Vahid1919]

This might be resolved, when we update and Storybook, move over to the current version of wc-storybook-helpers and apply a patch we already have at Synergy: https://github.com/synergy-design-system/synergy-design-system/blob/69f8e7a12a6f5d21ff0c84cde56c95f48508b72c/patches/wc-storybook-helpers%401.5.3.patch#L33

cc @smfonseca

@mariohamann @karlbaumhauer
In that case, would it make sense to simply close this issue and mention that this will be resolved by the refactoring ticket?

[karlbaumhauer]

This might be resolved, when we update and Storybook, move over to the current version of wc-storybook-helpers and apply a patch we already have at Synergy: https://github.com/synergy-design-system/synergy-design-system/blob/69f8e7a12a6f5d21ff0c84cde56c95f48508b72c/patches/wc-storybook-helpers%401.5.3.patch#L33
cc @smfonseca

@mariohamann @karlbaumhauer In that case, would it make sense to simply close this issue and mention that this will be resolved by the refactoring ticket?

@Vahid1919
if @yoezlem agrees, could you just update it and apply the patch? I don't know how much effort this might be but as @mariohamann already provided the solution, we could just do it?
@mariohamann estimation?
@yoezlem priority?

[mariohamann]

Maybe we just wait with what @smfonseca comes up with, when the docs PR is ready, as he will have to update quite some dependencies already. Let's maybe move this to draft until that?

[karlbaumhauer]

Maybe we just wait with what @smfonseca comes up with, when the docs PR is ready, as he will have to update quite some dependencies already. Let's maybe move this to draft until that?

fine for me.