Fix styleguide #353
Fix styleguide #353
Conversation
somewhat working config, changes maybe necessary
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
This looks great! One thing, can you add a little tidbit to the README.md about how to run this with npm run documentation. Maybe @AbhiramTadepalli would like you to give a little spiel at the next Trends meeting too.
Also just wanted to confirm if any more packages from here can be removed and if any can be moved from dependencies to devDependencies as this is only something we'll run for development.
|
@NishilJ I'm good to merge once you address these 2 things |
|
Okay, I will add some instructions to the main page and see if any more unused dependencies can be removed. I mention the naming scheme issue, I think I will add it in this pr for ease of use. Do you have any preference for the casing that all component names, component file names, and component folder names can follow? |
|
I think most have a capital letter to start for the folder, lowercase for the file, and uppercase for the default exported function in the file. That would probably reduce the number of changes most. |
Overview
Fixes to styleguideist config so that it runs and removal of unnecessary dependencies.
Other Notes
The styleguide/documentation js bundle can be locally viewed using
npx styleguidist serverand can be built usingnpx styleguidist buildwhich will output to the styleguide folder. This build folder was removed from git. Certain component folder/file names may need to be changed in the future so that the casing matches with the corresponding component name, file name, and folder name.