Vue-cli: Docs overhaul

Created on 25 Oct 2018  路  6Comments  路  Source: vuejs/vue-cli

Reference issue for docs refactor

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

  • User Manual (for the users of vue-cli and vue-cli ui)
  • Plugin developer docs

Checklist:

  • Improve docs (obviously)
  • Move the plugin development docs to a separate website (for example vue-cli-dev.vuejs.org)
  • Create a complete plugin dev guide
  • Create a full API reference
contribution welcome discussion documentation

Most helpful comment

Working on plugin dev guide + API reference

All 6 comments

cc @NataliaTepluhina

Working on plugin dev guide + API reference

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

@Akryum same as @JonathanDn

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

Thanks

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

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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

eladcandroid picture eladcandroid  路  3Comments

PrimozRome picture PrimozRome  路  3Comments

joshuajohnson814 picture joshuajohnson814  路  3Comments

jgribonvald picture jgribonvald  路  3Comments

b-zee picture b-zee  路  3Comments