Altinn / altinn-studio

Next generation open source Altinn platform and applications.
https://docs.altinn.studio
BSD 3-Clause "New" or "Revised" License
109 stars 73 forks source link

As a user, I want to see a short description for Studio components in Storybook #13077

Open Ildest opened 2 days ago

Ildest commented 2 days ago

Description

What

First stage: For the components that correspond to the components in the designs system, we could copy the description of the design system component, so that we have a minimum introduction and "when to use" in our own Storybook.

Example:

image

Copy this first sentence, and if possible, this part:

image

Second stage (most likely a separate issue for after the summer): Create similar descriptions and guidelines for components in Studio that are unique to our product.

Why

A win for developers and designers that quickly want to see what a component is for and how to best use it.

Additional Information

@framitdavid please review this issue

Tasks

  1. Edit mdx-files for relevant components in a separate branch.
  2. Have someone review it
  3. Publish/push.

Acceptance Criterias

Each component that is similar to a component in the design system, has a description and if relevant, guidelines.