PWA Studio Docs Reorg

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "projectManager.openInCurrenWindowIfEmpty": "never"
+}

gatsby-config.js

@@ -10,17 +10,17 @@
  * governing permissions and limitations under the License.
  */
 
-const { versions, pages, subPages } = require("./src/data/navigation");
+const { pages, subPages } = require("./src/data/navigation");
 
 module.exports = {
   siteMetadata: {
-    versions: versions,
     pages: pages,
     subPages: subPages,
+    home: { hidden: true },
   },
   plugins: [`@adobe/gatsby-theme-aio`],
   pathPrefix: process.env.PATH_PREFIX || "/commerce/pwa-studio/",
   flags: {
     DEV_SSR: false
-  }
+  },
 };

src/data/navigation/sections/api/buildpack.js → src/data/navigation/apis/buildpack.js

@@ -1,116 +1,116 @@
 module.exports = {
   title: "Buildpack",
-  path: "/api/buildpack/",
+  path: "/",
   pages: [
     {
       title: "Overview",
-      path: "/api/buildpack/",
+      path: "/",
     },
     {
       title: "BuildBus",
-      path: "/api/buildpack/buildbus/",
+      path: "/",
     },
     {
       title: "Command Line Interface",
-      path: "/api/buildpack/cli/",
+      path: "/",
       pages: [
         {
           title: "Create project",
-          path: "/api/buildpack/cli/create-project/",
+          path: "/",
         },
         {
           title: "Create environement file",
-          path: "/api/buildpack/cli/create-environment-file/",
+          path: "/",
         },
         {
           title: "Load environment file",
-          path: "/api/buildpack/cli/load-environment-file/",
+          path: "/",
         },
         {
           title: "Create custom origin",
-          path: "/api/buildpack/cli/create-custom-origin/",
+          path: "/",
         },
       ],
     },
     {
       title: "Environment configuration",
-      path: "/api/buildpack/environment/",
+      path: "/",
       pages: [
         {
           title: "Environment variables",
-          path: "/api/buildpack/environment/variables/",
+          path: "/",
         },
         {
           title: "EnvVarDefinition object",
-          path: "/api/buildpack/environment/definition-object/",
+          path: "/",
         },
       ],
     },
     {
       title: "Targets",
-      path: "/api/buildpack/targets/",
+      path: "/",
     },
     {
       title: "Targetables",
-      path: "/api/buildpack/targetables/",
+      path: "/",
       pages: [
         {
           title: "TargetableModule",
-          path: "/api/buildpack/targetables/TargetableModule/",
+          path: "/",
         },
         {
           title: "TargetableESModule",
-          path: "/api/buildpack/targetables/TargetableESModule/",
+          path: "/",
         },
         {
           title: "TargetableESModuleArray",
-          path: "/api/buildpack/targetables/TargetableESModuleArray/",
+          path: "/",
         },
         {
           title: "TargetableESModuleObject",
-          path: "/api/buildpack/targetables/TargetableESModuleObject/",
+          path: "/",
         },
         {
           title: "TargetableReactComponent",
-          path: "/api/buildpack/targetables/TargetableReactComponent/",
+          path: "/",
         },
         {
           title: "TargetableSet",
-          path: "/api/buildpack/targetables/TargetableSet/",
+          path: "/",
         },
         {
           title: "SingleImportStatement",
-          path: "/api/buildpack/targetables/SingleImportStatement/",
+          path: "/",
         },
       ],
     },
     {
       title: "Transform requests",
-      path: "/api/buildpack/transform-requests/",
+      path: "/",
     },
     {
       title: "Webpack tools",
-      path: "/api/buildpack/webpack/",
+      path: "/",
       pages: [
         {
           title: "Configure Webpack",
-          path: "/api/buildpack/webpack/configure/",
+          path: "/",
         },
         {
           title: "Magento resolver",
-          path: "/api/buildpack/webpack/magento-resolver/",
+          path: "/",
         },
         {
           title: "Magento root components plugin",
-          path: "/api/buildpack/webpack/magento-root-components-plugin/",
+          path: "/",
         },
         {
           title: "PWA development server",
-          path: "/api/buildpack/webpack/dev-server/",
+          path: "/",
         },
         {
           title: "Service worker plugin",
-          path: "/api/buildpack/webpack/service-worker/",
+          path: "/",
         },
       ],
     },

src/data/navigation/sections/api/index.js → src/data/navigation/apis/index.js

@@ -1,10 +1,11 @@
 const buildpack = require("./buildpack");
 const peregrine = require("./peregrine");
 const venia = require("./venia");
+
 module.exports = [
   {
     title: "Overview",
-    path: "/api/",
+    path: "/",
   },
   buildpack,
   peregrine,

src/data/navigation/apis/peregrine.js

@@ -0,0 +1,100 @@
+module.exports = {
+  title: "Peregine",
+  path: "/",
+  pages: [
+    {
+      title: "Overview",
+      path: "/",
+    },
+    {
+      title: "Targets",
+      path: "/",
+    },
+    {
+      title: "Components and utilities",
+      path: "/",
+      pages: [
+        {
+          title: "Item",
+          path: "/",
+        },
+        {
+          title: "Items",
+          path: "/",
+        },
+        {
+          title: "List",
+          path: "/",
+        },
+        {
+          title: "Router",
+          path: "/",
+        },
+      ],
+    },
+    {
+      title: "Custom React hooks",
+      path: "/",
+      pages: [
+        {
+          title: "useDropdown",
+          path: "/",
+        },
+        {
+          title: "useEventListener",
+          path: "/",
+        },
+        {
+          title: "usePagination",
+          path: "/",
+        },
+        {
+          title: "useSearchParam",
+          path: "/",
+        },
+        {
+          title: "useToasts",
+          path: "/",
+        },
+        {
+          title: "useToastContext",
+          path: "/",
+        },
+        {
+          title: "useWindowSize",
+          path: "/",
+        },
+      ],
+    },
+    {
+      title: "Shopping Cart Talons",
+      path: "/",
+      pages: [
+        {
+          title: "Cart Page",
+          path: "/",
+        },
+        {
+          title: "Gift Cards",
+          path: "/",
+        },
+        {
+          title: "Gift Options",
+          path: "/",
+        },
+        {
+          title: "Price Adjustments",
+          path: "/",
+        },
+        {
+          title: "Price Summary",
+          path: "/",
+        },
+        {
+          title: "Product Listing",
+          path: "/",
+        },
+      ],
+    },
+  ],
+};

src/data/navigation/apis/venia.js

@@ -0,0 +1,86 @@
+module.exports = {
+  title: "Venia UI",
+  path: "/",
+  pages: [
+    {
+      title: "Overview",
+      path: "/",
+    },
+    {
+      title: "Targets",
+      path: "/",
+    },
+    {
+      title: "General components",
+      path: "/",
+      pages: [
+        {
+          title: "Button",
+          path: "/",
+        },
+        {
+          title: "ButtonGroup",
+          path: "/",
+        },
+        {
+          title: "Link",
+          path: "/",
+        },
+        {
+          title: "Logo",
+          path: "/",
+        },
+        {
+          title: "Mask",
+          path: "/",
+        },
+        {
+          title: "Portal",
+          path: "/",
+        },
+        {
+          title: "ProductImageCarousel",
+          path: "/",
+        },
+        {
+          title: "Shimmer",
+          path: "/",
+        },
+        {
+          title: "ToastContainer",
+          path: "/",
+        },
+        {
+          title: "Trigger",
+          path: "/",
+        },
+      ],
+    },
+    {
+      title: "Shopping cart",
+      path: "/",
+      pages: [
+        {
+          title: "Cart Page",
+          path: "/",
+        },
+        {
+          title: "Gift Cards",
+          path: "/",
+        },
+        {
+          title: "Price Adjustments",
+          path: "/",
+        },
+        {
+          title: "Price Summary",
+          path: "/",
+        },
+        {
+          title: "Product Listing",
+          path: "/",
+        },
+      ],
+    },
+  ],
+};