docs: add scrollBehavior API detail and link to guide (vuejs#954)

aethr · posva · web-flow · commit 1544f4e2705b · 2021-05-18T15:45:29.000+02:00
* docs: add scrollBehavior API detail and link to guide

* Update docs/api/index.md

Co-authored-by: Eduardo San Martin Morote &lt;posva@users.noreply.github.com&gt;
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -746,12 +746,12 @@ routes: RouteRecordRaw[]
 
 ### scrollBehavior
 
-Function to control scrolling when navigating between pages. Can return a Promise to delay scrolling. Check .
+Function to control scrolling when navigating between pages. Can return a Promise to delay when the scrolling happens. See [Scroll Behaviour](../guide/advanced/scroll-behavior.md) for more details.
 
 **Signature:**
 
 ```typescript
-scrollBehavior?: ScrollBehavior
+scrollBehavior?: RouterScrollBehavior
 ```
 
 #### Examples
