Skip to content

chore(docs): Add error FAQs to docs #283

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

Merged
merged 1 commit into from
Jan 11, 2020
Merged

chore(docs): Add error FAQs to docs #283

merged 1 commit into from
Jan 11, 2020

Conversation

benmvp
Copy link
Contributor

@benmvp benmvp commented Jan 10, 2020

Problem

I was setting up babel-plugin-react-css-modules (with React Storybook) and ran into a number of errors. And because I wasn't quite sure how this plugin worked, I wasn't quite sure how to fix the errors. Three days later the docs make way more sense did they did.

Solution

I've proposed a number of doc tweaks as well as a couple of new FAQ issues around the errors I was running into w/ proposed solutions. The solutions also give more insight into how the plugin works so that other folks using the plugin can inform themselves to hopefully solve their problems as well.

Notes

  • I wanted to reformat the Options table because it's a nightmare to read because of the horizontal scrolling, but I left that out
  • I saw a lot of StackOverflow questions with folks posting their .babelrc including postcss-nested with postcss-scss. I believe it's not needed because SCSS already supports nesting. I assume folks have that in their code because the example includes it. I couldn't think of a good additional plugin to pair, so I added an FYI note.

@gajus gajus merged commit e3636b3 into gajus:master Jan 11, 2020
@benmvp
Copy link
Contributor Author

benmvp commented Jan 11, 2020

Thanks for the quick merge!

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

Successfully merging this pull request may close these issues.

2 participants