Sync docs from README.md to docs/*.md#3116
Conversation
|
Thoughts on whether we should generate from I've redirected the EDIT THIS DOC buttons on the website to the |
|
Or maybe we should not have so much info in the README and link to docs instead? I know this might be controversial but I think it’s more sane |
|
Yeah that's also an option. We'd have to make sure everything in the README is covered elsewhere though. Babel's README works like this. |
package.json
Outdated
| "jest-docblock": "21.3.0-beta.1", | ||
| "jest-validate": "21.1.0", | ||
| "leven": "2.1.0", | ||
| "markdown-magic": "^0.1.19", |
There was a problem hiding this comment.
Gah, I keep doing this. Need to figure out why my yarn isn't respecting .yarnrc.
|
@vjeux thoughts on this vs just redirecting from Readme to website and building that out more? |
|
I don't feel strongly about the two variants. Either we redirect to the website or we make sure the two are kept in sync. |
|
Seems more sane to only keep the docs in one place. Better for maintenance and contribution via GitHub (without needing to run build tools). Opened #3139 |
This is a lower-tech variant of #2825.
markdown-magic.markdown-tocwithmarkdown-magicCloses #2825
Supersedes #2937