vuejs/vue-router

[Docs] Incomplete Navigation Resolution Flow

Open

#2184 opened on May 4, 2018

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

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

Tech stack
vuejavascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
understanding of Vue navigation guardsMarkdown editingdiagram tool knowledge (e.g., draw.io)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the current navigation guards documentation at docs/en/advanced/navigation guards.md, particularly the section on full navigation resolution flow. Look at the Vue lifecycle diagram at https://vuejs.org/v2/guide/instance.html#Lifecycle Diagram for inspiration on creating a similar diagram. Examine the 13 comments on this issue for any specific suggestions or constraints about the diagram content.