Skip to content

Commit 0439aa9

Browse files
committed
docs: add outdated warnings on style guide pages
1 parent 2cc09cb commit 0439aa9

File tree

4 files changed

+16
-0
lines changed

4 files changed

+16
-0
lines changed

src/style-guide/rules-essential.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Priority A Rules: Essential {#priority-a-rules-essential}
22

3+
::: warning Note
4+
This Vue.js Style Guide is outdated and needs to be reviewed. If you have any questions or suggestions, please [open an issue](https://github.com/vuejs/docs/issues/new).
5+
:::
6+
37
These rules help prevent errors, so learn and abide by them at all costs. Exceptions may exist, but should be very rare and only be made by those with expert knowledge of both JavaScript and Vue.
48

59
## Use multi-word component names {#use-multi-word-component-names}

src/style-guide/rules-recommended.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Priority C Rules: Recommended {#priority-c-rules-recommended}
22

3+
::: warning Note
4+
This Vue.js Style Guide is outdated and needs to be reviewed. If you have any questions or suggestions, please [open an issue](https://github.com/vuejs/docs/issues/new).
5+
:::
6+
37
Where multiple, equally good options exist, an arbitrary choice can be made to ensure consistency. In these rules, we describe each acceptable option and suggest a default choice. That means you can feel free to make a different choice in your own codebase, as long as you're consistent and have a good reason. Please do have a good reason though! By adapting to the community standard, you will:
48

59
1. Train your brain to more easily parse most of the community code you encounter

src/style-guide/rules-strongly-recommended.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Priority B Rules: Strongly Recommended {#priority-b-rules-strongly-recommended}
22

3+
::: warning Note
4+
This Vue.js Style Guide is outdated and needs to be reviewed. If you have any questions or suggestions, please [open an issue](https://github.com/vuejs/docs/issues/new).
5+
:::
6+
37
These rules have been found to improve readability and/or developer experience in most projects. Your code will still run if you violate them, but violations should be rare and well-justified.
48

59
## Component files {#component-files}

src/style-guide/rules-use-with-caution.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Priority D Rules: Use with Caution {#priority-d-rules-use-with-caution}
22

3+
::: warning Note
4+
This Vue.js Style Guide is outdated and needs to be reviewed. If you have any questions or suggestions, please [open an issue](https://github.com/vuejs/docs/issues/new).
5+
:::
6+
37
Some features of Vue exist to accommodate rare edge cases or smoother migrations from a legacy code base. When overused however, they can make your code more difficult to maintain or even become a source of bugs. These rules shine a light on potentially risky features, describing when and why they should be avoided.
48

59
## Element selectors with `scoped` {#element-selectors-with-scoped}

0 commit comments

Comments
 (0)