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

Make auto generated SVG paths clearer #1208

Open
michaeljaltamirano opened this issue Oct 11, 2021 · 2 comments
Open

Make auto generated SVG paths clearer #1208

michaeljaltamirano opened this issue Oct 11, 2021 · 2 comments

Comments

@michaeljaltamirano
Copy link
Contributor

michaeljaltamirano commented Oct 11, 2021

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.

@zcaceres
Copy link
Contributor

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.

@zcaceres
Copy link
Contributor

@jashieh or @daigof cooldown project idea? 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants