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: A small suggestion #3647

Closed
JackingLuo opened this issue Jul 9, 2019 · 4 comments · Fixed by #4161 or mariazevedo88/hash-generator-js#14 · May be fixed by bermudez/mynuxtjs#1 or mariazevedo88/hash-generator-js#15

Comments

@JackingLuo
Copy link

commented Jul 9, 2019

There is no denying that Bootstrap is a good component library for fast building PC and mobile code, and I also like to use Bootstrap. But compared with other VUE component libraries (such as elementUI), Bootstrap VUE documentation is not friendly to developers. It is hoped that the document will be optimized in later iterations. Convenient for more developers to use!

@jackmu95 jackmu95 added the Type: Docs label Jul 9, 2019
@jackmu95

This comment has been minimized.

Copy link
Member

commented Jul 9, 2019

@JackingLuo Thanks for your feedback. We always try to make the documentation as developer-friendly as possible.

Would be good if you can give us some more details where you think we can improve or lack details in comparison with the docs of other libraries as Element UI.

@JackingLuo

This comment has been minimized.

Copy link
Author

commented Jul 9, 2019

I think the most unfriendly place is that only type and default values are provided in `Properties', and there is no corresponding function description. In the development project, if you need to add a function, you need to go to the above examples to find, especially the first time to use the Vuer of this component library! Although the naming of attributes is semantic, a word cannot fully describe a function.

@tmorehouse

This comment has been minimized.

Copy link
Member

commented Jul 9, 2019

Currently the component definition is automatically generated by the docs via inspection of the props defined on the component from componentDef.$options.props, Vue currently doesn't provide a prop option property for additional information (which would end up bloating the components with plain text strings not used by the component itself).

There is an interesting discussion at the VueJS repo on this: vuejs/vue#7186

@JackingLuo

This comment has been minimized.

Copy link
Author

commented Jul 9, 2019

Okay, thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.