solid-design-system / solid

Monorepo for Union Investment's Solid Design System.
https://solid-design-system.fe.union-investment.de/docs/
Other
21 stars 4 forks source link

docs: 📚 bring back documentation #1420

Closed mariohamann closed 1 month ago

mariohamann commented 1 month ago

Description

We're documenting how a component works and what it does and which features it offers – not just single attributes!

During our docs migration, there were former docs migrated to templates (instead of the definition that only samples are moved to templates), that are definitely needed for proper documentation to understand how to use the component:

Where to put the documentation

DoR

DoD

Vahid1919 commented 1 month ago

One the sidenote regarding radio-button template. I believe that was created before we decided to turn all radio/radio-button stories into sd-radio-groups. It was not an intentional choice to add it after the fact. But I see how it is somehow "obsolete" now.