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

* docs: add scrollBehavior API detail and link to guide

* Update docs/api/index.md

Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com>

diff --git a/docs/api/index.md b/docs/api/index.md
index f708c3ff02afccccaa6b42d521ada73a496f912e..c0ba0e15cd9e880dd5422cfea1bf63600c98f593 100644 (file)
--- 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