vuejs / vue-cli

🛠️ webpack-based tooling for Vue.js Development
https://cli.vuejs.org/
MIT License
29.75k stars 6.32k forks source link

Docs overhaul #2810

Open Akryum opened 5 years ago

Akryum commented 5 years ago

Reference issue for docs refactor

We are planning on overhauling the documentation for vue-cli soon. There will be two docs sites:

Checklist:

Akryum commented 5 years ago

cc @NataliaTepluhina

NataliaTepluhina commented 5 years ago

Working on plugin dev guide + API reference

JonathanDn commented 5 years ago

@Akryum I would love to help if you could guide me to a specific area in the docs that need mending/improving

christiannwamba commented 5 years ago

@Akryum same as @JonathanDn

Would love to help if there's a path or somewhere you would love us to get started from.

Thanks

rkunev commented 5 years ago

Bumping the Docs overhaul issue!

I think there's an opportunity to improve the docs about Build Targets and the --target lib. Specifically, about useBuiltIns config for lib authors. @vue/babel-preset-app docs already explain it, but I think it's not easy to find this information and a number of projects ship dist files sometimes twice as large, just because of the polyfills.

Here's a fresh example of how just using the Number prop validator like this:

props: {
  limit: {
    type: Number, // <- es6.number.constructor polyfill is added
    default: 0
  }
}

increases the (unminified) bundle size from 17.33 KiB to 39.42 KiB.

Would you be interested in a Pull Request for the docs? cc: @Akryum @NataliaTepluhina

nklayman commented 4 years ago

With the release of vue cli v4, it would be really nice to have a guide on migrating plugins. It also appears as if the new migrate feature is undocumented.

brenzy commented 3 years ago

It would be great if looking at older versions of the documentation was added here as well. It is confusing for me what works with Vue 2, 3, and 4.