Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation for developers extending this package #890

Open
mikemonteith opened this issue Sep 20, 2023 · 2 comments
Open

Better documentation for developers extending this package #890

mikemonteith opened this issue Sep 20, 2023 · 2 comments
Labels
documentation User requests new documentation or improvements to existing documentation sass / css

Comments

@mikemonteith
Copy link
Contributor

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
@sarawilcox sarawilcox added documentation User requests new documentation or improvements to existing documentation sass / css labels Sep 20, 2023
@mikemonteith
Copy link
Contributor Author

@mikemonteith
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User requests new documentation or improvements to existing documentation sass / css
Projects
None yet
Development

No branches or pull requests

2 participants