You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our documentation about adding SVGs is confusing in part because the auto-generated SVG path (e.g. src/icons/emojis/svgs/AnxiousEmoji.tsx) is similar to the SVGs path we are adding the actual SVGs. (e.g. src/svgs/emojis/anxious-emoji.svg).
One way to make the manual/auto-generated steps more distinguished would be to give the auto-generated steps a more clearly identifiable name, e.g. outputting the SVG components to src/icons/emojis/autoGeneratedSvgComponents/AnxiousEmoji.tsx. This would help make the documentation better with clearer naming, and prevent potential confusion and user error about the steps in the future.
To do this we would just updating the naming paths in package.json script steps, and then do a global find and replace the import paths in the files in which we import the auto-generated SVG Components.
The text was updated successfully, but these errors were encountered:
Could also prepend an underscore before the auto-gen directories. Basically anything that can signal to someone who's looking for patterns in the source code that there's something special about those directories.
Our documentation about adding SVGs is confusing in part because the auto-generated SVG path (e.g.
src/icons/emojis/svgs/AnxiousEmoji.tsx
) is similar to the SVGs path we are adding the actual SVGs. (e.g.src/svgs/emojis/anxious-emoji.svg
).One way to make the manual/auto-generated steps more distinguished would be to give the auto-generated steps a more clearly identifiable name, e.g. outputting the SVG components to
src/icons/emojis/autoGeneratedSvgComponents/AnxiousEmoji.tsx
. This would help make the documentation better with clearer naming, and prevent potential confusion and user error about the steps in the future.To do this we would just updating the naming paths in
package.json
script steps, and then do a global find and replace the import paths in the files in which we import the auto-generated SVG Components.The text was updated successfully, but these errors were encountered: