vuejs/vue-router

[Docs] Incomplete Navigation Resolution Flow

Open

#2,184 opened on May 4, 2018

View on GitHub
 (13 comments) (0 reactions) (0 assignees)JavaScript (5,092 forks)batch import
contribution welcomedocsgood first issue

Repository metrics

Stars
 (19,015 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

What problem does this feature solve?

https://github.com/vuejs/vue-router/blob/dev/docs/en/advanced/navigation-guards.md#the-full-navigation-resolution-flow

I think the docs are lacking full flow, not mentioning 'beforeRouteLeave' for example. Would be cool if diagram were to be created, such as used on Vue lifecycle

https://vuejs.org/v2/guide/instance.html#Lifecycle-Diagram

Contributor guide

Research direction
Review the current navigation guard documentation and create a diagram similar to the Vue lifecycle diagram, ensuring all guards including beforeRouteLeave are included.
Tech stack
javascriptvue
Domain
frontenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90