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, mariazevedo88/hash-generator-js#14, mariazevedo88/hash-generator-js#15 or tghelere/CL#8 · May be fixed by bermudez/mynuxtjs#1
Closed

docs: A small suggestion #3647

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

Comments

@JackingLuo
Copy link

@JackingLuo JackingLuo 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!

@jacobmllr95
Copy link
Member

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

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

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

@JackingLuo JackingLuo commented Jul 9, 2019

Okay, thank you.

@tmorehouse tmorehouse changed the title A small suggestion docs: A small suggestion Jul 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment