search

Altinn / altinn-studio

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

Delete unnecessary MDX files #13300

Closed TomasEng closed 1 month ago

TomasEng commented 2 months ago

Most of the MDX files in the studio-components library do not provide any useful documentation. We should delete those files in order to limit the amount of maintenance work.

This kind of documentation should only be added on components that are made for some special use cases, not for the basic ones.

Ildest commented 2 months ago

Great, I suggested to @framitdavid earlier that we take the first sentence of descriptions from the design system for the common components, and then create our own descriptions for custom Studio components. Let me know if that is something we stil want to do, and I can help. A new user would probably like to know at a quick glance what a component can be used for.

TomasEng commented 2 months ago

As long as we only use this internally, I don't think that's necessary, @Ildest. We should rather focus on writing self-explanatory code.