Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
[doc feedback] .babelrc doc page starts out very confusingly for newcomers #7196
The .babelrc doc page starts out very confusingly for newcomers:
I just got there from the initial setup instructions which says I need one, and then it starts with that confusing sentence about callbacks or options, but not telling me which options there even are.
As I got to this page, my questions were: 1. How does a common .babelrc to start out with look like? (example) and 2. What options can I use there?. None of those are answered, since "Babel API options" is not actually a link or anything and the example right below looks oddly specific, not like a good starting point. (or maybe it is? it doesn't tell me for sure if this is a common example with the
I recommend adding a new section at the top that gives a brief explanation of the purpose of .babelrc, then gives the most basic one most people would want to run, and then actually links the Babel API options and points out the common ones one might want to use.
Right now it seems to be written for people who are already deeply familiar with Babel API options, and not anyone like me who is new to the tool.
Hey @JonasT! We really appreciate you taking the time to report an issue. The collaborators
It always seemed weird to me that the docs for the transform options were not in the page describing the way they will be set 99% of time. I don't think babel needs to go full https://webpack.js.org/configuration/ but maybe moving options to babelrc could make sense, especially now
In any case babel 7 will require rewriting pretty much the whole thing anyway (e.g. #5276 and