vuejs / docs

📄 Documentation for Vue 3
https://vuejs.org
Other
2.92k stars 4.41k forks source link

[Style Guide] Outdated styleguide - it's about time #2565

Open Nagell opened 11 months ago

Nagell commented 11 months ago

Hi guys,

as you surely know, the style guide is quite outdated.

Vue 3 is there for a while. <script setup> is really great. I could even say that this is the most flexible, save and user friendly syntax, but there is no guide for it at all. All in all the docs are giving me a vibe of <script setup> not being that interesting anymore. Maybe even docs itself are not the most interesting thing for dev team right now, but for newcomers they are!

This harms the image of once greatly documented mature ecosystem. There is always more and more adoption in business, but it means at the same time that we have more and more inexperienced colleagues trying to make something in vue from time to time. And they are producing spaghetti - lots of it. Since the composition API we can put any amount of features in a single component and mix everything as we like, but "with the great power comes..." - you know the drill.

Side note: I already regret this decision. At the end of the day we have two extremes:

I'm quite sure, that there are more experienced guys there to speak of the best practices. Not trying to just toss a topic and run. Nothing like this. If I'll find a couple of 'I know the sh...'-guys I can gladly exchange ideas and take responsibility for moderating it and writing it down.

Want to help? Maybe you know someone? Please, let me know.

In hope that it will get some traction, kind regards

NataliaTepluhina commented 10 months ago

@Nagell just to make it clear: you would like to see a new section in the styleguide that would recommend how to structure the code written with Composition API in <script setup>?

Nagell commented 10 months ago

@NataliaTepluhina the short answer is: yes. A bit longer one is: I would advocate that it might be recommended to use Githubissues.

  • Githubissues is a development platform for aggregating issues.