Merge pull request #6 from modio/update_file_structure

Update file structure

.github/workflows/push-modio-docs.yml

@@ -21,7 +21,7 @@ jobs:
         env:
           API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }}
         with:
-          source-directory: 'public/Console Platforms'
+          source-directory: 'public/console-platforms'
           destination-github-username: "modio"
           destination-repository-name: "modio-docs-internal"
           commit-message: "docs: updating public docs (console platforms) from modio-docs repo"
@@ -33,7 +33,7 @@ jobs:
         env:
           API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }}
         with:
-          source-directory: 'public/Game Management/Dependencies'
+          source-directory: 'public/game-management/dependencies'
           destination-github-username: "modio"
           destination-repository-name: "modio-docs-internal"
           commit-message: "docs: updating public docs (dependencies) from modio-docs repo"
@@ -57,7 +57,7 @@ jobs:
         env:
           API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }}
         with:
-          source-directory: 'public/Game Management/Moderation'
+          source-directory: 'public/game-management/moderation'
           destination-github-username: "modio"
           destination-repository-name: "modio-docs-internal"
           commit-message: "docs: updating public docs (moderation) from modio-docs repo"
@@ -69,7 +69,7 @@ jobs:
         env:
           API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }}
         with:
-          source-directory: 'public/Integration'
+          source-directory: 'public/integration'
           destination-github-username: "modio"
           destination-repository-name: "modio-docs-internal"
           commit-message: "docs: updating public docs (integration) from modio-docs repo"
@@ -81,7 +81,7 @@ jobs:
         env:
           API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }}
         with:
-          source-directory: 'public/REST API'
+          source-directory: 'public/rest-api'
           destination-github-username: "modio"
           destination-repository-name: "modio-docs-internal"
           commit-message: "docs: updating public docs (REST API) from modio-docs repo"
@@ -93,7 +93,7 @@ jobs:
         env:
           API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }}
         with:
-          source-directory: 'public/Support'
+          source-directory: 'public/support'
           destination-github-username: "modio"
           destination-repository-name: "modio-docs-internal"
           commit-message: "docs: updating public docs (support) from modio-docs repo"
@@ -123,3 +123,16 @@ jobs:
           commit-message: "docs: updating public docs (web) from modio-docs repo"
           target-branch: main
           target-directory: public/web
+
+
+      - name: Push menu structure to modio-docs-internal
+        uses: cpina/github-action-push-to-another-repository@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }}
+        with:
+          source-directory: 'menu'
+          destination-github-username: "modio"
+          destination-repository-name: "modio-docs-internal"
+          commit-message: "docs: update public menu from modio-docs repo"
+          target-branch: main
+          target-directory: /

menu/sidebars.js

@@ -0,0 +1,233 @@
+import 'dotenv/config'
+
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+
+// @ts-check
+
+const url = process.env.URL || 'http://localhost:3000'
+const startStyle = `
+  <div class="tw-flex tw-flex-row tw-items-center tw-w-full tw-px-8 tw-space-x-4 tw-font-bold tw-tracking-widest">
+`
+const endStyle = '</div>'
+const startStylePush = `<div class="tw-mt-5" />${startStyle}`
+
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+  // By default, Docusaurus generates a sidebar from the docs folder structure
+  sidebar: [
+    // mod.io
+    // Integration
+    {
+      type: 'html',
+      value: `${startStylePush}MOD.IO${endStyle}`,
+      defaultStyle: true,
+    },
+    {
+      type: 'autogenerated', dirName: 'modio',
+    },
+    // Integration
+    {
+      type: 'html',
+      value: `${startStylePush}GAME INTEGRATION${endStyle}`,
+      defaultStyle: true,
+    },
+    {
+      type: 'category',
+      label: 'Unreal',
+      link: {type: 'doc', id: 'unreal/index-unreal'},
+      items: ['unreal/installation-and-setup', 'unreal/getting-started', 'unreal/ui-getting-started', 'unreal/profiling', 'unreal/mod-creation-tool', 'unreal/android-configuration',   
+      {
+        type: 'link',
+        label: 'Unreal Reference', 
+        href: `${url}/unrealref/#_classes`, 
+      },
+    ],
+    },
+    {
+      type: 'category',
+      label: 'Unity',
+      link: {type: 'doc', id: 'integration/unity/unity'},
+      items: ['integration/unity/unity-setup', 'integration/unity/unity-getting-started', 'integration/unity/unity-ugc-browser', 'integration/unity/unity-marketplace', 
+      {
+        type: 'link',
+        label: 'Unity Reference', 
+        href: `${url}/unityref/`, 
+      },
+    ],
+    },
+    {
+      type: 'category',
+      label: 'C++ SDK',
+      link: {type: 'doc', id: 'sdk/index-sdk'},
+      items: [
+        'sdk/installation-and-setup', 'sdk/getting-started',
+        {
+          type: 'category',
+          label: 'Windows',
+          link: {type: 'doc', id: 'sdk/win32/windows-getting-started'},
+          items: ['sdk/win32/windows-cmake-integration']
+        },
+        {
+          type: 'category',
+          label: 'Linux',
+          link: {type: 'doc', id: 'sdk/linux/linux-getting-started'},
+          items: ['sdk/linux/linux-cmake-integration']
+        },
+        {
+          type: 'category',
+          label: 'Mac',
+          link: {type: 'doc', id: 'sdk/macos/mac-getting-started'},
+          items: ['sdk/macos/mac-cmake-integration']
+        },
+        {
+          type: 'category',
+          label: 'iOS',
+          link: {type: 'doc', id: 'sdk/ios/ios-getting-started'},
+          items: ['sdk/ios/ios-cmake-integration']
+        },
+        {
+          type: 'category',
+          label: 'Android',
+          link: {type: 'doc', id: 'sdk/android/android-getting-started'},
+          items: ['sdk/android/android-cmake-integration']
+        }, 
+        {
+          type: 'link',
+          label: 'C++ SDK Reference', 
+          href: `${url}/cppsdkref/#_functions`, 
+        },
+      ],
+    },
+    // Console Platforms
+    {
+      type: 'html',
+      value: `${startStylePush}CONSOLE PLATFORMS${endStyle}`,
+      defaultStyle: true,
+    },
+    {
+      type: 'doc',
+      id: 'console-platforms/platforms',
+      label: 'Supporting Console Platforms',
+    },
+    {
+      type: 'doc',
+      id: 'console-platforms/platforms-playstation',
+      label: 'PlayStation\u00ae4 & PlayStation\u00ae5',
+    },
+    {
+      type: 'doc',
+      id: 'console-platforms/platforms-switch',
+      label: 'Nintendo Switch',
+    },
+    {
+      type: 'doc',
+      id: 'console-platforms/platforms-gdk',
+      label: 'Xbox One & Xbox Series X/S',
+    },
+    {
+      type: 'doc',
+      id: 'console-platforms/platforms-console-sdks',
+      label: 'Console SDKs',
+    },
+    // Game Management
+    {
+      type: 'html',
+      value: `${startStylePush}GAME MANAGEMENT${endStyle}`,
+      defaultStyle: true,
+    },
+    // {
+    //   type: 'category',
+    //   label: 'Monetization',
+    //   items: ['Game Management/Monetization/monetization', 'Game Management/Monetization/getting-started'],
+    // },
+    {
+      type: 'category',
+      label: 'Moderation',
+      link: {type: 'doc', id: 'game-management/moderation/moderation'},
+      items: ['game-Management/moderation/automated-scanning', 'game-management/moderation/manual-curation', 'game-management/moderation/community-reports',
+
+        {
+          type: 'category',
+          label: 'Rules Engine',
+          link: {type: 'doc', id: 'game-management/moderation/rules-engine'},
+          items: ['game-management/moderation/rules-engine-setup', 'game-management/moderation/rules-engine-webhooks', 'game-management/moderation/rules-engine-monitoring', 'game-management/moderation/rules-engine-examples'],
+        },
+      ],
+    },
+    {
+      type: 'doc',
+      id: 'game-management/dependencies/dependency-management',
+      label: 'Dependencies',
+    },
+    // Remove Metrics until we get the docs written
+    // {
+    //   type: 'category',
+    //   label: 'Metrics',
+    //   items: ['Game Management/Metrics/metrics', 'Game Management/Metrics/metrics-dashboards', 'Game Management/Metrics/metrics-trending', 'Game Management/Metrics/metrics-ccu', 'Game Management/Metrics/metrics-export'],
+    // },
+    // WEB SERVICES
+    {
+      type: 'html',
+      value: `${startStylePush}WEB SERVICES${endStyle}`,
+      defaultStyle: true,
+    },
+    {
+      type: 'category',
+      label: 'Authentication',
+      items: [,
+
+      {
+        type: 'category',
+        label: 'For Players',
+        link: {type: 'doc', id: 'web/authentication/overview'},
+        items: ['web/authentication/openid', 'web/authentication/website-studio-sso'],
+      },
+      {
+        type: 'doc',
+        id: 'web/authentication/s2s',
+        label: 'For Web Servers',
+      },
+    ]
+    },
+    {
+      type: 'category',
+      label: 'Marketplace',
+      link: {type: 'doc', id: 'web/iap/overview'},
+      items: ['web/iap/studio-as-purchase-server'],
+    },
+    // REST API
+    {
+      type: 'html',
+      value: `${startStylePush}REST API${endStyle}`,
+      defaultStyle: true,
+    },
+    {
+        type: 'autogenerated', dirName: 'rest-api',
+    }, 
+    {
+      type: 'link',
+      label: 'REST API Reference', 
+      href: `${url}/restapiref/`, 
+    },
+    // Support
+    {
+      type: 'html',
+      value: `${startStylePush}SUPPORT${endStyle}`,
+      defaultStyle: true,
+    },
+    {
+      type: 'autogenerated', dirName: 'support',
+    },
+  ],
+};
+
+export default sidebars;