kpn / kpn-style

Reusable (style) packages for anyone working on front-end for KPN.
https://style.kpn.com
MIT License
17 stars 4 forks source link

Make sure all documentation is correct for variables, mixins, and functions #15

Open coenkoopmans opened 4 years ago

coenkoopmans commented 4 years ago

Description

The portal on style.kpn.com references many different variables, mixins, and functions. Some of those might be outdated, as the code has changed. Someone needs to check all of the pages to see if everything is still correct, and if not, fix it.

11

Currently, a list of mixins is shown, as well as a few examples on how to use them. This is nice and workable, but lacks explanation. What does each of these mixins do? Do they accept arguments? Anything to keep in mind? Any concrete examples?

24

Currently, all pages that have them (such as button, input, and block) start with "Customizable variables". It is however not stated what exactly these variables do. It is more of an advanced feature for people who already understand the component better than someone who is taking their first look. For this reason, please move all the customizable variables to the bottom of all the relevant pages.

Acceptance criteria