nhsuk-frontend icon indicating copy to clipboard operation
nhsuk-frontend copied to clipboard

Better documentation for developers extending this package

Open mikemonteith opened this issue 2 years ago • 2 comments

The documentation in the service manual is excellent for people who want to use the nhsuk-library components in their project, but there is a lack of documenatation for developers who are creating new components that they intend to contribute back into the service manual, or creating custom components specific to their service.

Things that could be documented better:

  • Sass variables
  • Sass mixins
  • CSS Utility classes
  • Best practices for creating your own good CSS

mikemonteith avatar Sep 20 '23 08:09 mikemonteith

GOV have this https://frontend.design-system.service.gov.uk/sass-api-reference/

mikemonteith avatar Sep 20 '23 10:09 mikemonteith

Also could document how to include the variables and mixins without also including any actual CSS styles. This is important for teams who are using a framework which compiles scss such as sass-loader for webpack.

mikemonteith avatar Sep 21 '23 12:09 mikemonteith