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

Deprecation of SCSS only documentation #332

Closed
andy-polhill opened this issue Apr 26, 2021 · 1 comment
Closed

Deprecation of SCSS only documentation #332

andy-polhill opened this issue Apr 26, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@andy-polhill
Copy link
Contributor

We are tentatively deciding to deprecate documentation for those applications only using the SCSS/CSS. This refers to the manual documentation that can be found in the storybook notes.

If any projects are using SCSS/CSS only, things will still work as expected, but in the future you will have to inspect the code to determine what classes to provide.

  • The manual documentation was providing quite a time overhead in terms of contributing new components.
  • The manual documentation was difficult to keep up to date
  • The manual documentation could draw a team into using only the scss/css where it would have been preferable to use the Angular components.

Initially the intention of this documentation was to help with teams not using Angular, it is however quite cumbersome and received little interest for the amount of effort put into it. If you are a team who use this approach, or would be interested in using Canopy not with Angular we do have some advanced experiments with Angular Elements. Please respond on this issue.

In time we will start to remove the scss only documentation, and will keep this issue up to date.

@andy-polhill andy-polhill added documentation Improvements or additions to documentation question Further information is requested labels Apr 26, 2021
@andy-polhill andy-polhill pinned this issue Apr 26, 2021
@andy-polhill
Copy link
Contributor Author

This will most likely be a part of #35

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants