vuejs / vuejs/docs

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

Open
#2,565 17 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

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:

  • ordering props/emits/... as if it would not be Composition API at all (old order)
  • creating a 1500 lines long unreadable component + 500 lines of style
    (yes, i was there, saw it with my own eyes... and they still hurt)

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing style guide at https://vuejs.org/style-guide/ and review how it addresses Vue 3, Composition API, and <script setup>. The issue does not identify specific files or tests; completion would require an agreed scope and a written, updated set of style guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.