update router documentation

zth · Sep 11, 2024 · 537cdad · 537cdad
1 parent 2e9cdc5
commit 537cdad
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/rescript-relay-documentation/docs/experimental-router.md b/rescript-relay-documentation/docs/experimental-router.md
diff --git a/rescript-relay-documentation/docs/router.md b/rescript-relay-documentation/docs/router.md
@@ -0,0 +1,9 @@
+---
+id: router
+title: Router
+sidebar_label: Router
+---
+
+The [rescript-relay-router](https://www.npmjs.com/package/rescript-relay-router) is designed for scale, performance and ergonomics. Tailored for usage with `rescript-relay`. A _modern_ router, targeting modern browsers and developer workflows using `vite`.
+
+Read all about the [rescript-relay-router](https://github.com/zth/rescript-relay-router/blob/main/packages/rescript-relay-router/README.md) at the official repository.
diff --git a/rescript-relay-documentation/sidebars.js b/rescript-relay-documentation/sidebars.js
@@ -52,7 +52,7 @@ module.exports = {
       "using-with-hasura",
       "using-with-schemas-that-dont-conform-to-the-relay-spec",
       "migrating-from-javascript-typescript-incrementally",
-      "experimental-router",
+      "router",
       "migrating-to-v3",
     ],
     Misc: ["the-compiler", "quirks-of-rescript-relay", "examples"],