Changes for fixing docs (#4220)

* Moved docs to root folder * Updated documentation configurations * Temporarily removed check for release * Fixes in build commands * Fix for install failed * Restored release trigger on non pr flows only.
EtherealEngine · Nov 26, 2021 · 439d4b7 · 439d4b7
1 parent cdbf3b9
commit 439d4b7
Show file tree

Hide file tree

Showing 72 changed files with 316 additions and 290 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -18,22 +18,22 @@ jobs:
           if [ ${{ secrets.DOCUMENTATION_BUILD_ENABLED }} == 'true' ]; then
             echo "::set-output name=ok::enabled"
           fi
-  # checks:
-  #   if: github.event_name != 'push'
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v2
-  #     - uses: actions/setup-node@v2
-  #       with:
-  #         node-version: 16.x
-  #     - name: Test Build
-  #       env:
-  #         NODE_OPTIONS: --max_old_space_size=8192
-  #       run: |
-  #         npm install --production=false --legacy-peer-deps
-  #         cd packages/docs
-  #         npm install --production=false --legacy-peer-deps
-  #         npm run build
+  checks:
+    if: github.event_name != 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+      - name: Test Build
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |
+          npm install --production=false --legacy-peer-deps
+          cd docs
+          npm install --production=false --legacy-peer-deps
+          npm run build
   gh-release:
     needs:
       - secrets-gate
@@ -57,6 +57,6 @@ jobs:
           git config --global user.email "actions@github.com"
           git config --global user.name "gh-actions"
           npm install --production=false --legacy-peer-deps
-          cd packages/docs
+          cd docs
           npm install --production=false --legacy-peer-deps
           npm run deploy
diff --git a/.gitignore b/.gitignore
@@ -138,8 +138,8 @@ bin/
 # JetBrains WebStorm/PhpStorm
 .idea
 
-# Hugo publish files
-packages/docs/public/
+# Docs generated file
+/docs/docs/generated/
 
 .history
 .history/*
@@ -167,3 +167,4 @@ certs/
 /packages/client/public/projects/*
 /packages/projects/projects/*
 /packages/client/optimizeDeps.json
+
diff --git a/packages/docs/.eslintrc.cjs → docs/.eslintrc.cjs b/packages/docs/.eslintrc.cjs → docs/.eslintrc.cjs
diff --git a/packages/docs/.gitignore → docs/.gitignore b/packages/docs/.gitignore → docs/.gitignore
@@ -19,7 +19,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-docs/**/**
 docs-client/
 docs-client-core/
 docs-client-common/

diff --git a/packages/docs/CHANGELOG.md → docs/CHANGELOG.md b/packages/docs/CHANGELOG.md → docs/CHANGELOG.md
diff --git a/packages/docs/LICENSE → docs/LICENSE b/packages/docs/LICENSE → docs/LICENSE
diff --git a/packages/docs/babel.config.js → docs/babel.config.js b/packages/docs/babel.config.js → docs/babel.config.js
diff --git a/packages/docs/docs/0_introduction.md → docs/docs/0_introduction.md b/packages/docs/docs/0_introduction.md → docs/docs/0_introduction.md
diff --git a/...docs/0_modules/api-server/architecture.md → ...docs/0_modules/api-server/architecture.md b/...docs/0_modules/api-server/architecture.md → ...docs/0_modules/api-server/architecture.md
diff --git a/...cs/0_modules/api-server/authentication.md → ...cs/0_modules/api-server/authentication.md b/...cs/0_modules/api-server/authentication.md → ...cs/0_modules/api-server/authentication.md
diff --git a/...s/docs/0_modules/api-server/networking.md → docs/docs/0_modules/api-server/networking.md b/...s/docs/0_modules/api-server/networking.md → docs/docs/0_modules/api-server/networking.md
diff --git a/...ocs/docs/0_modules/api-server/services.md → docs/docs/0_modules/api-server/services.md b/...ocs/docs/0_modules/api-server/services.md → docs/docs/0_modules/api-server/services.md
diff --git a/...ocs/docs/0_modules/client/architecture.md → docs/docs/0_modules/client/architecture.md b/...ocs/docs/0_modules/client/architecture.md → docs/docs/0_modules/client/architecture.md
diff --git a/...s/docs/0_modules/client/authentication.md → docs/docs/0_modules/client/authentication.md b/...s/docs/0_modules/client/authentication.md → docs/docs/0_modules/client/authentication.md
diff --git a/.../docs/docs/0_modules/client/components.md → docs/docs/0_modules/client/components.md b/.../docs/docs/0_modules/client/components.md → docs/docs/0_modules/client/components.md
diff --git a/.../docs/docs/0_modules/client/networking.md → docs/docs/0_modules/client/networking.md b/.../docs/docs/0_modules/client/networking.md → docs/docs/0_modules/client/networking.md
diff --git a/packages/docs/docs/0_modules/client/state.md → docs/docs/0_modules/client/state.md b/packages/docs/docs/0_modules/client/state.md → docs/docs/0_modules/client/state.md
diff --git a/...ages/docs/docs/0_modules/client/worlds.md → docs/docs/0_modules/client/worlds.md b/...ages/docs/docs/0_modules/client/worlds.md → docs/docs/0_modules/client/worlds.md
diff --git a/...ocs/docs/0_modules/engine/architecture.md → docs/docs/0_modules/engine/architecture.md b/...ocs/docs/0_modules/engine/architecture.md → docs/docs/0_modules/engine/architecture.md
diff --git a/packages/docs/docs/0_modules/engine/audio.md → docs/docs/0_modules/engine/audio.md b/packages/docs/docs/0_modules/engine/audio.md → docs/docs/0_modules/engine/audio.md
diff --git a/...ges/docs/docs/0_modules/engine/avatars.md → docs/docs/0_modules/engine/avatars.md b/...ges/docs/docs/0_modules/engine/avatars.md → docs/docs/0_modules/engine/avatars.md
diff --git a/packages/docs/docs/0_modules/engine/ecs.md → docs/docs/0_modules/engine/ecs.md b/packages/docs/docs/0_modules/engine/ecs.md → docs/docs/0_modules/engine/ecs.md
diff --git a/...ocs/docs/0_modules/engine/file-loading.md → docs/docs/0_modules/engine/file-loading.md b/...ocs/docs/0_modules/engine/file-loading.md → docs/docs/0_modules/engine/file-loading.md
diff --git a/packages/docs/docs/0_modules/engine/input.md → docs/docs/0_modules/engine/input.md b/packages/docs/docs/0_modules/engine/input.md → docs/docs/0_modules/engine/input.md
diff --git a/.../docs/docs/0_modules/engine/networking.md → docs/docs/0_modules/engine/networking.md b/.../docs/docs/0_modules/engine/networking.md → docs/docs/0_modules/engine/networking.md
diff --git a/...ges/docs/docs/0_modules/engine/physics.md → docs/docs/0_modules/engine/physics.md b/...ges/docs/docs/0_modules/engine/physics.md → docs/docs/0_modules/engine/physics.md
diff --git a/...ges/docs/docs/0_modules/engine/prefabs.md → docs/docs/0_modules/engine/prefabs.md b/...ges/docs/docs/0_modules/engine/prefabs.md → docs/docs/0_modules/engine/prefabs.md
diff --git a/...ages/docs/docs/0_modules/engine/worlds.md → docs/docs/0_modules/engine/worlds.md b/...ages/docs/docs/0_modules/engine/worlds.md → docs/docs/0_modules/engine/worlds.md
diff --git a/...ocs/0_modules/game-server/architecture.md → ...ocs/0_modules/game-server/architecture.md b/...ocs/0_modules/game-server/architecture.md → ...ocs/0_modules/game-server/architecture.md
diff --git a/.../docs/0_modules/game-server/networking.md → .../docs/0_modules/game-server/networking.md b/.../docs/0_modules/game-server/networking.md → .../docs/0_modules/game-server/networking.md
diff --git a/...s/docs/docs/0_modules/ops/architecture.md → docs/docs/0_modules/ops/architecture.md b/...s/docs/docs/0_modules/ops/architecture.md → docs/docs/0_modules/ops/architecture.md
diff --git a/.../docs/docs/0_modules/ops/db-migrations.md → docs/docs/0_modules/ops/db-migrations.md b/.../docs/docs/0_modules/ops/db-migrations.md → docs/docs/0_modules/ops/db-migrations.md
diff --git a/...ges/docs/docs/0_modules/ops/deployment.md → docs/docs/0_modules/ops/deployment.md b/...ges/docs/docs/0_modules/ops/deployment.md → docs/docs/0_modules/ops/deployment.md
diff --git a/packages/docs/docs/0_modules/ops/docker.md → docs/docs/0_modules/ops/docker.md b/packages/docs/docs/0_modules/ops/docker.md → docs/docs/0_modules/ops/docker.md
diff --git a/packages/docs/docs/0_modules/ops/email.md → docs/docs/0_modules/ops/email.md b/packages/docs/docs/0_modules/ops/email.md → docs/docs/0_modules/ops/email.md
diff --git a/...ges/docs/docs/0_modules/ops/kubernetes.md → docs/docs/0_modules/ops/kubernetes.md b/...ges/docs/docs/0_modules/ops/kubernetes.md → docs/docs/0_modules/ops/kubernetes.md
diff --git a/...ocs/docs/1_guides/virtualworld/1_setup.md → docs/docs/1_guides/virtualworld/1_setup.md b/...ocs/docs/1_guides/virtualworld/1_setup.md → docs/docs/1_guides/virtualworld/1_setup.md
diff --git a/...cs/docs/1_guides/virtualworld/2_editor.md → docs/docs/1_guides/virtualworld/2_editor.md b/...cs/docs/1_guides/virtualworld/2_editor.md → docs/docs/1_guides/virtualworld/2_editor.md
diff --git a/.../docs/1_guides/virtualworld/3_location.md → .../docs/1_guides/virtualworld/3_location.md b/.../docs/1_guides/virtualworld/3_location.md → .../docs/1_guides/virtualworld/3_location.md
diff --git a/...s/docs/1_guides/virtualworld/4_avatars.md → docs/docs/1_guides/virtualworld/4_avatars.md b/...s/docs/1_guides/virtualworld/4_avatars.md → docs/docs/1_guides/virtualworld/4_avatars.md
diff --git a/.../1_guides/virtualworld/5_interactables.md → .../1_guides/virtualworld/5_interactables.md b/.../1_guides/virtualworld/5_interactables.md → .../1_guides/virtualworld/5_interactables.md
diff --git a/...ocs/1_guides/virtualworld/6_deployment.md → ...ocs/1_guides/virtualworld/6_deployment.md b/...ocs/1_guides/virtualworld/6_deployment.md → ...ocs/1_guides/virtualworld/6_deployment.md
diff --git a/packages/docs/docs/1_installation.md → docs/docs/1_installation.md b/packages/docs/docs/1_installation.md → docs/docs/1_installation.md
diff --git a/packages/docs/docs/2_examples/360player.md → docs/docs/2_examples/360player.md b/packages/docs/docs/2_examples/360player.md → docs/docs/2_examples/360player.md
diff --git a/packages/docs/docs/2_examples/harmony.md → docs/docs/2_examples/harmony.md b/packages/docs/docs/2_examples/harmony.md → docs/docs/2_examples/harmony.md
diff --git a/...ages/docs/docs/2_examples/hellophysics.md → docs/docs/2_examples/hellophysics.md b/...ages/docs/docs/2_examples/hellophysics.md → docs/docs/2_examples/hellophysics.md
diff --git a/packages/docs/docs/2_examples/helloworld.md → docs/docs/2_examples/helloworld.md b/packages/docs/docs/2_examples/helloworld.md → docs/docs/2_examples/helloworld.md
diff --git a/packages/docs/docs/2_examples/socialmedia.md → docs/docs/2_examples/socialmedia.md b/packages/docs/docs/2_examples/socialmedia.md → docs/docs/2_examples/socialmedia.md
diff --git a/...docs/docs/2_examples/socialmultiplayer.md → docs/docs/2_examples/socialmultiplayer.md b/...docs/docs/2_examples/socialmultiplayer.md → docs/docs/2_examples/socialmultiplayer.md
diff --git a/packages/docs/docs/2_examples/volumetric.md → docs/docs/2_examples/volumetric.md b/packages/docs/docs/2_examples/volumetric.md → docs/docs/2_examples/volumetric.md
diff --git a/packages/docs/docs/2_troubleshooting.md → docs/docs/2_troubleshooting.md b/packages/docs/docs/2_troubleshooting.md → docs/docs/2_troubleshooting.md
diff --git a/packages/docs/docs/3_contributing.md → docs/docs/3_contributing.md b/packages/docs/docs/3_contributing.md → docs/docs/3_contributing.md
diff --git a/packages/docs/docs/3_coreconcepts.md → docs/docs/3_coreconcepts.md b/packages/docs/docs/3_coreconcepts.md → docs/docs/3_coreconcepts.md
diff --git a/packages/docs/docs/4_architecture.md → docs/docs/4_architecture.md b/packages/docs/docs/4_architecture.md → docs/docs/4_architecture.md
diff --git a/packages/docs/docs/mdx_example.mdx → docs/docs/mdx_example.mdx b/packages/docs/docs/mdx_example.mdx → docs/docs/mdx_example.mdx
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -0,0 +1,209 @@
+/** @type {import('@docusaurus/types').DocusaurusConfig} */
+
+const commonExludePaths = [
+  '**/node_modules/**',
+  '**/dist/**',
+  '**/tests/**'
+];
+
+/**
+ *
+ * @author Abhinav Shah
+ * @author Hanzla Mateen
+ */
+module.exports = {
+  title: 'xrengine',
+  tagline:
+    'An end-to-end solution for hosting humans and AI in a virtual space, built on top of react, three.js and express/feathers.',
+  url: 'https://xrfoundation.github.io',
+  baseUrl: '/xrengine-docs/',
+  onBrokenLinks: 'warn',
+  onBrokenMarkdownLinks: 'warn',
+  favicon:
+    'https://github.com/xrfoundation/xrengine/raw/dev/xrengine%20black.png',
+  organizationName: 'XRFoundation', // Usually your GitHub org/user name.
+  projectName: 'xrengine-docs', // Usually your repo name.
+  plugins: [
+    // [
+    //   'docusaurus-plugin-typedoc',
+    //   {
+    //     id: 'client',
+    //     entryPoints: ['../packages/client/src/main.tsx'],
+    //     entryPointStrategy: 'expand',
+    //     tsconfig: '../packages/client/tsconfig.json',
+    //     exclude: [
+    //       ...commonExludePaths,
+    //       '../packages/client/vite.config.js',
+    //       '../packages/client/jest.config.js',
+    //       '../packages/client/public/**',
+    //       '../packages/client/lib/**',
+    //       '../packages/client/scripts/**'
+    //     ],
+    //     out: 'generated/client',
+    //     readme: 'none',
+    //   },
+    // ],
+    // [
+    //   'docusaurus-plugin-typedoc',
+    //   {
+    //     id: 'client-core',
+    //     entryPoints: ['../packages/client-core'],
+    //     entryPointStrategy: 'expand',
+    //     tsconfig: '../packages/client-core/tsconfig.json',
+    //     exclude: [
+    //       ...commonExludePaths,
+    //       '../packages/client-core/build.js',
+    //       '../packages/client-core/rollup.config.js',
+    //       '../packages/client-core/jest.config.js',
+    //       '../packages/client-core/scripts/**',
+    //     ],
+    //     out: 'generated/client-core',
+    //     readme: 'none',
+    //   },
+    // ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        id: 'server',
+        entryPoints: ['../packages/server'],
+        entryPointStrategy: 'expand',
+        tsconfig: '../packages/server/tsconfig.json',
+        exclude: [
+          ...commonExludePaths,
+          '../packages/server/public/**',
+          '../packages/server/scripts/**',
+          '../packages/server/tests old/**',
+          '../packages/server/.eslintrc.js',
+        ],
+        out: 'generated/server',
+        readme: 'none',
+      },
+    ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        id: 'server-core',
+        entryPoints: ['../packages/server-core/src/'],
+        entryPointStrategy: 'expand',
+        tsconfig: '../packages/server-core/tsconfig.json',
+        exclude: [ 
+          ...commonExludePaths,
+          '../packages/server-core/scripts/**',
+          '../packages/server-core/.eslintrc.js',
+          '../packages/server-core/.mocharc.js',
+          '../packages/server-core/rollup.config.js',
+          '../packages/server-core/vite.build.js'
+        ],
+        out: 'generated/server-core',
+        readme: 'none',
+      },
+    ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        id: 'common',
+        entryPoints: ['../packages/common'],
+        entryPointStrategy: 'expand',
+        tsconfig: '../packages/common/tsconfig.json',
+        exclude: [
+          ...commonExludePaths,
+          '../packages/common/scripts/**',
+          '../packages/common/.eslintrc.cjs',
+          '../packages/common/rollup.config.js',
+          '../packages/common/vite.build.js'
+        ],
+        out: 'generated/common',
+        readme: 'none',
+      }, 
+    ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        id: 'engine',
+        entryPoints: ['../packages/engine/src/'],
+        entryPointStrategy: 'expand',
+        tsconfig: '../packages/engine/tsconfig.json',
+        exclude: [
+          ...commonExludePaths,
+          '../packages/engine/scripts/**',
+          '../packages/engine/.mocharc.js',
+          '../packages/engine/rollup.config.js',
+          '../packages/engine/vite.build.js',
+          '../packages/engine/src/physics/physx/physx.release.cjs.js',
+          '../packages/engine/src/physics/physx/physx.release.esm.js',
+        ],
+        out: 'generated/engine',
+        readme: 'none',
+      },
+    ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        id: 'gameserver',
+        entryPoints: ['../packages/gameserver/src/'],
+        entryPointStrategy: 'expand',
+        tsconfig: '../packages/gameserver/tsconfig.json',
+        exclude: [
+          ...commonExludePaths,
+          '../packages/gameserver/.eslintrc.cjs',
+          '../packages/gameserver/.mocharc.js',
+          '../packages/gameserver/vite.build.js'
+        ],
+        out: 'generated/gameserver',
+        readme: 'none',
+      },
+    ],
+  ],
+  themeConfig: {
+    navbar: {
+      title: 'XREngine',
+      logo: {
+        alt: 'Logo',
+        src: 'https://github.com/XRFoundation/XREngine/raw/dev/xrengine%20black.png',
+      },
+      items: [
+        {
+          to: 'docs/',
+          activeBasePath: 'docs',
+          label: 'Docs',
+          position: 'left',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Community',
+          items: [
+            {
+              label: 'Discord',
+              href: 'https://discord.gg/mQ3D4FE',
+            },
+            {
+              label: 'Github',
+              href: 'https://github.com/XRFoundation/XREngine',
+            }
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} XRFoundation.`,
+    },
+  },
+  presets: [
+    [
+      '@docusaurus/preset-classic',
+      {
+        docs: {
+          sidebarPath: require.resolve('./sidebars.js'),
+          // Please change this to your repo.
+          editUrl:
+            'https://github.com/XRFoundation/XREngine/packages/docs/',
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+      },
+    ],
+  ],
+}
diff --git a/packages/docs/package.json → docs/package.json b/packages/docs/package.json → docs/package.json
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -0,0 +1,87 @@
+/**
+ * 
+ * @author Abhinav Shah
+ * @author Hanzla Mateen
+ */
+module.exports = {
+  sidebar: {
+    'Getting Started': [
+        'introduction',
+        'installation',
+        'coreconcepts', 
+        'architecture', 
+        'contributing',
+        {
+          type: 'category',
+          label: 'Packages',
+          collapsed: false,
+          items: [
+            // {
+            //   type: 'category',
+            //   label: 'client',
+            //   collapsed: true,
+            //   items: [{
+            //     type: 'autogenerated',
+            //     dirName: 'generated/client',
+            //   }],
+            // },
+            // {
+            //   type: 'category',
+            //   label: 'client-core',
+            //   collapsed: true,
+            //   items: [{
+            //     type: 'autogenerated',
+            //     dirName: 'generated/client-core',
+            //   }],
+            // },
+            {
+              type: 'category',
+              label: 'server',
+              collapsed: true,
+              items: [{
+                type: 'autogenerated',
+                dirName: 'generated/server',
+              }],
+            },
+            {
+              type: 'category',
+              label: 'server-core',
+              collapsed: true,
+              items: [{
+                type: 'autogenerated',
+                dirName: 'generated/server-core',
+              }],
+            },
+            {
+              type: 'category',
+              label: 'common',
+              collapsed: true,
+              items: [{
+                type: 'autogenerated',
+                dirName: 'generated/common',
+              }],
+            },
+            {
+              type: 'category',
+              label: 'engine',
+              collapsed: true,
+              items: [{
+                type: 'autogenerated',
+                dirName: 'generated/engine',
+              }],
+            },
+            {
+              type: 'category',
+              label: 'gameserver',
+              collapsed: true,
+              items: [{
+                type: 'autogenerated',
+                dirName: 'generated/gameserver',
+              }],
+            },
+          ],
+        },
+    ],
+  },
+};
+
diff --git a/packages/docs/src/css/custom.css → docs/src/css/custom.css b/packages/docs/src/css/custom.css → docs/src/css/custom.css
diff --git a/packages/docs/src/pages/index.js → docs/src/pages/index.js b/packages/docs/src/pages/index.js → docs/src/pages/index.js
diff --git a/packages/docs/src/pages/markdown-page.md → docs/src/pages/markdown-page.md b/packages/docs/src/pages/markdown-page.md → docs/src/pages/markdown-page.md
diff --git a/packages/docs/src/pages/styles.module.css → docs/src/pages/styles.module.css b/packages/docs/src/pages/styles.module.css → docs/src/pages/styles.module.css
diff --git a/packages/docs/static/.nojekyll → docs/static/.nojekyll b/packages/docs/static/.nojekyll → docs/static/.nojekyll
diff --git a/packages/docs/static/img/favicon.ico → docs/static/img/favicon.ico b/packages/docs/static/img/favicon.ico → docs/static/img/favicon.ico
diff --git a/packages/docs/static/img/logo.svg → docs/static/img/logo.svg b/packages/docs/static/img/logo.svg → docs/static/img/logo.svg
diff --git a/...static/img/undraw_docusaurus_mountain.svg → ...static/img/undraw_docusaurus_mountain.svg b/...static/img/undraw_docusaurus_mountain.svg → ...static/img/undraw_docusaurus_mountain.svg
diff --git a/...cs/static/img/undraw_docusaurus_react.svg → docs/static/img/undraw_docusaurus_react.svg b/...cs/static/img/undraw_docusaurus_react.svg → docs/static/img/undraw_docusaurus_react.svg
diff --git a/...ocs/static/img/undraw_docusaurus_tree.svg → docs/static/img/undraw_docusaurus_tree.svg b/...ocs/static/img/undraw_docusaurus_tree.svg → docs/static/img/undraw_docusaurus_tree.svg
diff --git a/packages/docs/typings.d.ts → docs/typings.d.ts b/packages/docs/typings.d.ts → docs/typings.d.ts
diff --git a/packages/docs/blog/2019-05-29-hello-world.md b/packages/docs/blog/2019-05-29-hello-world.md