sl-design-system / components

SL Design System
https://sanomalearning.design/
Apache License 2.0
39 stars 3 forks source link

Improve getting started documentation for developers #745

Closed DanielleRameau closed 9 months ago

DanielleRameau commented 10 months ago

As a developer I want to see a list of steps I need to take in order to get the SLDS working with my theme.

Clear steps on what you need to add to .npmrc or .yarnrc.yml:

@sl-design-system:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=XXXXXXXXX

(in the case of .npmrc)

### User stories
- [x] Angular + Svelte documentation
- [x] What do I need to do to let it work in my angular application?
- [x] Add clear steps on getting started page (step 1,2,3)
- [x] Why is my font not showing up?
- [x] Mention SSR
- [x] Mention how to switch between light and dark (is dark mode is available)
- [x] How to create a GitHub Token: should be classic & should have `read_packages` privilege at least
- [x] How to use the shared token within Bitbucket Pipelines
- [x] What Angular versions we support

CleanShot 2023-11-15 at 11 54 42@2x

anna-lach commented 10 months ago

Maybe also make some research about preparing bundle for Angular of our npm packages?

Diaan commented 9 months ago

https://sanoma-my.sharepoint.com/:w:/p/diana_broeders/ETWhVQXL_zNEsDyvMkg1U0YBErW7p4ww-NPFo5K8onxMfg?e=mJDQJi The current how to annotated with changes