Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs overhaul #2810

Open
Akryum opened this issue Oct 25, 2018 · 7 comments
Open

Docs overhaul #2810

Akryum opened this issue Oct 25, 2018 · 7 comments

Comments

@Akryum
Copy link
Member

Akryum commented Oct 25, 2018

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
@Akryum
Copy link
Member Author

Akryum commented Oct 25, 2018

cc @NataliaTepluhina

@NataliaTepluhina
Copy link
Member

Working on plugin dev guide + API reference

@JonathanDn
Copy link

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

@christiannwamba
Copy link

@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
Copy link

rkunev commented Jun 27, 2019

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
Copy link

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
Copy link

brenzy commented Jan 18, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants