Last 12 weeks · 19 commits
3 of 6 standards met
What This Does This adds a tip box to the guide explaining that Vue-specific attributes like , , and may appear as invalid in HTML validators or IDEs. These are Vue template directives and are expected to be handled by Vue's compiler. Why Fixes vuejs/vue#4428, which notes that new users may find these attributes invalid when writing Vue templates. This update clarifies that this is expected behavior and not a bug. Thanks!
Repository: vuejs/docs. Description: 📄 Documentation for Vue 3 Stars: 3184, Forks: 4996. Primary language: Vue. Languages: Vue (52.1%), JavaScript (18.7%), TypeScript (18.6%), HTML (5.6%), CSS (5%). Homepage: https://vuejs.org Topics: docs, hacktoberfest, vue, vue3. Open PRs: 25, open issues: 136. Last activity: 1d ago. Community health: 50%. Top contributors: yyx990803, NataliaTepluhina, skirtles-code, dependabot[bot], bencodezen, phanan, AloisSeckar, Jinjiang, sdras, jay-es and others.
Vue
Summary While auditing the Vue.js documentation for inclusive language, I found one instance of language rooted in the exploitation of animals. The Vue docs are already thoughtful about inclusive language in other respects (the writing guide recommends avoiding terms that "invalidate struggle" and is mindful of cultural sensitivity), so this is a suggestion to extend that care to animal-derived terminology. Finding in (line 61) "Additionally, we publish canary releases every week..." The term "canary release" originates from the practice of sending canaries into coal mines to detect toxic gases — the birds would become sick or die before miners were affected. While this is now a widespread software industry term, it normalizes a historical practice of using animals as disposable tools. Possible alternative: "preview release," "early-access release," or "nightly release" (the docs already use "pre-release" elsewhere on the same page). Note that the upstream npm packages are tagged , so a full change would require coordination with . Context The writing guide at already demonstrates strong awareness of inclusive language: Avoiding terms that invalidate struggle ("easy", "just", "obviously") Cultural sensitivity around humor and idioms Recommending simpler, plainer language over jargon Extending this awareness to animal-derived idioms would be consistent with these existing values. Scope This is a narrow finding — the rest of the documentation is clean of common speciesist idioms (no "dogfooding," "guinea pig," "monkey patching," "kill two birds," "beat a dead horse," "whitelist/blacklist," etc.). The suggestion is specifically about the "canary" terminology. Not requesting This is not a demand or a blocking concern. It's a suggestion for the team to consider as part of the broader trend in tech toward more inclusive and precise language. The alternative terms ("preview," "nightly," "early-access") are arguably clearer to non-native English speakers as well, which aligns with the writing guide's preference for "simpler, plainer language."
Hey! I was reading the docs about type-based defineProps and I think I found something that might be outdated or unclear. What's the issue? The docs say that imported types give for runtime inference: "If the type is a reference to an imported type, the inferred result will be (equal to any type) since the compiler does not have information of external files." https://vuejs.org/guide/typescript/composition-api.html#typing-component-props But I found that imported types from local project files actually work fine in dev mode. Reproduction What the docs suggest: What actually happens (dev mode): Vue correctly understands that is a string literal union and infers . Environment Vue 3.5.26 Question Does "imported type" in the docs specifically mean types from node_modules? If so, it would be helpful to clarify this because "imported type" sounds like any import.