fix(docs): update path to route in future API documentation (#563)

daangn · Jan 23, 2025 · 7440875 · 7440875
1 parent 4a194e1
commit 7440875
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 9 deletions.
diff --git a/.changeset/chilly-toys-cheer.md b/.changeset/chilly-toys-cheer.md
@@ -0,0 +1,5 @@
+---
+"@stackflow/docs": patch
+---
+
+Edit docs to match updated future api spec
diff --git a/docs/pages/api-references/future-api/api-pipelining.en.mdx b/docs/pages/api-references/future-api/api-pipelining.en.mdx
@@ -14,7 +14,7 @@ async function main() {
   let initialLoaderData: unknown | null = null;
 
   for (const activity of config.activities) {
-    const t = makeTemplate({ path: activity.path });
+    const t = makeTemplate({ path: activity.route });
     const match = t.parse(location.pathname + location.search);
 
     if (!match) {

diff --git a/docs/pages/api-references/future-api/api-pipelining.ko.mdx b/docs/pages/api-references/future-api/api-pipelining.ko.mdx
@@ -14,7 +14,7 @@ async function main() {
   let initialLoaderData: unknown | null = null;
 
   for (const activity of config.activities) {
-    const t = makeTemplate({ path: activity.path });
+    const t = makeTemplate({ path: activity.route });
     const match = t.parse(location.pathname + location.search);
 
     if (!match) {

diff --git a/docs/pages/api-references/future-api/changes.en.mdx b/docs/pages/api-references/future-api/changes.en.mdx
@@ -45,12 +45,23 @@ export const config = defineConfig({
       name: "HomeActivity",
 
       // You can declare the settings required by the History Sync Plugin in stackflow.config
-      path: "/",
+      route: "/",
     },
     {
       name: "MyProfileActivity",
-      path: "/my-profile",
-    }
+      route: "/my-profile",
+    },
+    {
+      name: "ArticleActivity",
+      route: {
+        path: "/articles/:articleId",
+        decode(params) {
+          return {
+            articleId: Number(params.get("articleId")),
+          };
+        },
+      },
+    },
   ],
   transitionDuration: 270,
 });

diff --git a/docs/pages/api-references/future-api/loader-api.en.mdx b/docs/pages/api-references/future-api/loader-api.en.mdx
@@ -30,12 +30,12 @@ export const config = defineConfig({
   activities: [
     {
       name: "HomeActivity",
-      path: "/",
+      route: "/",
       loader: homeActivityLoader,
     },
     {
       name: "MyProfileActivity",
-      path: "/my-profile",
+      route: "/my-profile",
     }
   ],
   transitionDuration: 270,

diff --git a/docs/pages/api-references/future-api/loader-api.ko.mdx b/docs/pages/api-references/future-api/loader-api.ko.mdx
@@ -30,12 +30,12 @@ export const config = defineConfig({
   activities: [
     {
       name: "HomeActivity",
-      path: "/",
+      route: "/",
       loader: homeActivityLoader,
     },
     {
       name: "MyProfileActivity",
-      path: "/my-profile",
+      route: "/my-profile",
     }
   ],
   transitionDuration: 270,