Move main plugin/package docs from here to babel/babel
See original GitHub issueIf you have issues please comment here, join our slack (signup: slack.babeljs.io, url: babeljs.slack.com), ping @babeljs on twitter
#528
eg http://babeljs.io/docs/plugins/transform-es2015-modules-systemjs/ vs https://github.com/babel/babel/tree/master/packages/babel-plugin-transform-es2015-modules-systemjs The “via CLI” & “via Node API” are missing. IMHO README should be the source for the webpage automated builder. Added preferred bonus: the web page links to README (“Edit doc contents in README”).
https://github.com/babel/babel.github.io/issues/528 was implemented via https://github.com/babel/babel.github.io/pull/990 (git submodule and rendering the markdown from the README)
Now this website repo can pull in information from the actual readme.md file used for npm in the babel repo.
Issue
What we need to do now is to move the docs in docs/
to link to the README’s in babel/babel/packages
Basically for those docs we want to take the contents there and replace them.
Example: https://github.com/babel/babel.github.io/pull/990/files#diff-b11e0ae0e12e1f69b9e7bd1a63ac06d2R20
Instructions
For each docs page that needs to be changed:
- Find the correct page on the babel website docs under
docs/
to edit: Example isdocs/plugins/preset-stage-0.md
- Find the corresponding page on
babel/babel
: Example is [babel-preset-stage-0/README.md
]
(https://github.com/babel/babel/blob/master/packages/babel-preset-stage-0/README.md)
- Copy over any missing information from the website page (this repo) to the main babel repo README (it’s not as updated usually).
This might be extra links, examples, etc:
- Replace the old contents with
{% include package_readme.html %}
This may mean a PR to the main babel repo as well as this repo.
Another Example
Check both https://github.com/babel/babel/pull/4884 and https://github.com/babel/babel.github.io/commit/241be67ed65a4162876972fff839dd5c318595c2
Misc
It’s fine to do this one pr at a time, you don’t have to change everything or all of the docs! (makes it easier to review too)
Issue Analytics
- State:
- Created 7 years ago
- Comments:6 (6 by maintainers)
Top GitHub Comments
Remaining READMEs to move (feel free to call dibs!):
I’m going to work on this!