Requirements

• Migrate the following pages:
  • Component Registration
  • Props
  • Custom Events
  • Slots
  • Dynamic & Async Components
  • Handling Edge Cases

Requirements

• Users should be able to easily modify content through the markdown file

When the prop has the type of Function, the default is treated as a value instead of factory:
https://github.com/vuejs/docs-next/blob/master/src/guide/component-props.md#prop-validation

    // Type function, the default will be the default function
    propG: {
      type: Function,
      default: function () {
        return 'Default function'
      },
    },

PR with the change vuejs/core#1349

Requirements

• Migrate the following pages:
  • Reactivity in Depth

Requirements

• Migrate the following pages:
  • Mixins
  • Custom Directives
  • Render Functions & JSX
  • Plugins

Requirements

• Add Migration guide from 2.x to 3.x

Per @mlama007, need to update the color on yellow:

#836e03

https://webaim.org/resources/contrastchecker/

From #31 (comment) and #31 (comment)

1. An example with reversedMessage on Computed properties chapter is introducing to complex handling of strings which is out of the scope here. We can add a simpler example something like the sum of two numbers as a computed property.

2. The example about in-template expressions makes sense, but we introduce computed properties as a mechanism to get derived values. The introduction as a solution to prevent complex expressions in templates does not sound that impressive.

Is there a way to make line numbers enabled to code blocks?

module.exports = {
  markdown: {
    lineNumbers: true
  }
}

Requirements

• Home page should look like the current vuejs.org site
• Content should be identical

Similar to https://deploy-preview-98--vue-next.netlify.app/guide/change-detection.html#declaring-reactive-properties

This page applies only to Vue 2.x and below, and assumes you've already read the Reactivity Section. Please read that section first.

Summary

In order to address concerns brought up via #40, I've created this issue to track how we lint docs going forward in order to make everyone's life easier. This will also have the benefit of making contributors lives easier since we won't have to request them to make stylistic changes anymore.

Example Problem

Prettier has styles that conflict with the Vue style guide (e.g., space before parentheses when defining functions) and @NataliaTepluhina brought up the idea of switching to ESLint.

Let people know what blocks are available to them

Moving the PR from the other repo over to docs-next, with the intention that we can get support from Maria or someone to take it to the next level

In #42, there was a discussion that this "### Automatic Global Registration of Base Components" is not needed in this section since it's more of a technique than a fundamental concept to understand.

The proposal is to move it to the Cookbook.

https://github.com/vuejs/rfcs/pull/16/files

To reduce friction for users transitioning to the docs site since there will be a separate redesign, the goal here is to migrate the old theme over to VuePress is a functional manner so it will be easy to extend when the redesign happens.

• Buttons for Why Vue.js and Get Started
• VueMastery video modal
• Patreon and OpenCollective sponsors integrations
• Patreon sponsors update bot integration
• Subscribe to Newsletter form

There is a method in DropdownTransition.vue: setHeight(items) that is inappropriately animating the heights.

Per @sdras:

we shouldn't be animating height here. I know the alternative is more work but I can do it in a followup PR, this causes layout thrashing and repaints

Requirements

• Migrate the following pages:
  • Routing (#79)
  • State Management (#94)
  • Server-Side Rendering (#95)

• Currently uses a function to assemble URLs based on version number
• Is there a better way for us to do this?

🦄 Consider MD / Vue Components in default VuePress theme for a convention for versioning strategy

• User should be able to show the code snippet version and a live demo of the actual code in action
• 🦄 This is currently done by duplicating the same code twice. A markdown extension or global Vue component could be the answer to make it eaisier to maintain
• @NataliaTepluhina also mentioned using the Vuetify examples as inspiration. +1 from me on that end.

https://www.notion.so/vueteam/Code-scenario-examples-edb7d6bfa2414077bde2fae42cad47cc

This is most likely managed somewhere via Hexo on the current site, so we'll need to figure this piece out before rolling it out to production

• Partners
• Themes

Similar to the current Vuejs.org site, we need a way to manage the sidebar content.

@mlama007 Feel free to break this down as much as you need!

We need to decide on how do we want to handle translations. I think for now it's really too much work to move them to separate folders on docs VuePress site so maybe it's a good idea to leave them as separate repos? Let's discuss

By now, API reference section is still missing a part of global APIs such as h, defineComponent, defineAsyncComponent etc.

Requirements

• Page should look identical to current https://vuejs.org/v2/guide/team.html
  • Left navigation with:
    • Special sponsor slot
    • Guide version dropdown
    • Auto-generated nav items
  • Center well for main content
  • Fixed position platinum sponsors

Requirements

• Migrate common page layout utilized by most of the site
  • Left nav with special sponsor section
  • Main column of content
  • Fixed platinum sponsors section

• Update styles on custom containers
• Add info container type

• Custom containers currently require a title, but not all usage within the docs have titles
• Icons to use:
  • Tip ⇒ Checkmark in a circle
  • Caution ⇒ Triangle with exclamation point
  • Danger ⇒ Red circle with exclamation point
    • I considered the X icon, but these are danger warnings as opposed to an adamant "Don't do this"

Already done:

• general rewrite
• new caveats with proxies
• new demos
• new page for change detections
• new page for rendering

Yet to do:

• Fix the demos, move them to the Vue account
• Make the demos click to load
• Review/rewrite of change detetion

Per @znck suggestion, we should detect these to pay more attention to these changes

In v2, this section belongs to Handling Edge Cases. Currently, we don't have edge cases section in docs at all but maybe it's worth creating one

Requirements

• Figure out strategy for hash level redirects implementation
• Determine maintenance strategy

Background

// /foo#hello -> /bar#hello
//
// For these cases where a section on one page has
// moved to a perhaps differently-named section on
// another page, we need this.

Requirements

• Migrate the following pages:
  • Single File Components #118
  • Unit Testing
  • TypeScript Support
  • Production Deployment

Currently, Style guide examples are copied from Vue2. We need to update them to match Vue 3 syntax

Merged RFC: https://github.com/vuejs/rfcs/pull/154/files

Similar to old docs, we should have

"Deployed by Netlify" in the footer

https://url.netlify.com/HJ8X2mxP8

Requirements

• Migrate the following pages:
  • Comparison with Other Frameworks
  • Join the Vue.js Community!
  • Meet the Team

Requirements

• Migrate the following pages:
  • Enter/Leave & List Transitions
  • State Transitions

Requirements

• Migrate the following pages:
  • Installation
  • Introduction
  • The Vue Instance
  • Template Syntax
  • Computed Properties and Watchers
  • Class and Style Bindings
  • Conditional Rendering
  • List Rendering
  • Event Handling
  • Form Input Bindings
  • Component Basics

Description updated to reflect a decision we've come up on comments

• Docs
  • Guide
  • Examples
  • Style Guide
  • Cookbook
• API Reference
• Ecosystem
  • Official Projects
    • There could be a page to brief core libs/tools like: vuex, vue-router, vue-test-utils, vue-cli, vue-devtools, eslint-plugin-vue, etc. one-by-one. At the same time of course provide the link to each of the respective project. At very last, provide a link to our GitHub org to guide people explore more projects made by us.
  • Community
    • Another page maybe to brief how to get help, news, roadmap, events, social media accounts, jobs, partners, awesome projects and themes, by listing all useful links in categories.
• Support Vue
• Translations