@ebay/skin 17.0.0 → 17.1.0-0

package/ICON-CREATION.md

@@ -2,6 +2,10 @@
 
 Skin uses the SVG tag to deliver all iconography. This guide will help you properly add or modify SVG files for the Skin library.
 
+**Base Icons Only**
+
+Only base icons should be used. No state-based icons, such as disabled icons or even possibly an icon relaying an error state (likely red), should be used. Those state modifications on icons should be handled downstream using `css` modifiers to allow for those variations.
+
 ## Step 1: Import the SVG
 
 In order to import the SVG into Skin, all you need to do is drop the SVG into `src/svg/icon` directory. The icon name will be the way the icon will be imported into Skin. If the icon does not have `icon-` prefix, it will be renamed automatically to include the prefix.
@@ -36,6 +40,12 @@ If you do not want an icon to show up in the skin docs, add the name of the icon
 In order to skip an icon to have it's CSS be generated add the name of the icon in `docs/_data/icons.yaml` under `skip` key. Then rerun `step 2` scripts.
 This can be done for certain icons which might want to have different sizes than those specified in the `viewbox`
 
+## Depcrating Icons
+
+When an icon is removed or renamed, it will need to get deprecated. If you want to deprecate an icon, add the name of the icon in `docs/_data/icons.yaml` under `deprecated` key. Then rerun `step 2` scripts. This will show (if none existed yet) a `Deprecated` section in the docs and include the icon. This will also remove the icon from the `icon.svg` bundle and remove the CSS for the icon.
+
+Deprecated icons are to remain until the next major version when they can be removed. After they are removed, the icon can be removed from the `deprecated` key and the `step 2` scripts can be rerun.
+
 ## Script changes
 
 Any script changes needed should be done in `scripts/generate-images.js`.