Fix the sidebar ordering

Author: leeyi45

docs/.vitepress/config.ts

@@ -12,10 +12,10 @@ const vitepressOptions: UserConfig = {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Module Development', link: '/modules' }
+      { text: 'Module Development', link: '/modules/' }
     ],
     siteTitle: 'SA Modules',
-    sociallinks: [
+    socialLinks: [
       { icon: 'github', link: _package.repository },
       {
         icon: 'gitbook',
@@ -29,204 +29,28 @@ const vitepressOptions: UserConfig = {
 };
 
 const commonSideBarOptions: VitePressSidebarOptions = {
-  sortMenusByFrontmatterOrder: true,
+  documentRootPath: '/src',
+  // sortMenusByName: true,
+
+  // TODO: Investigate? Do we need rewrite rules?
+  // folderLinkNotIncludesFileName: true,
   useFolderLinkFromSameNameSubFile: true,
   useFolderTitleFromIndexFile: true,
   useTitleFromFrontmatter: true,
   useTitleFromFileHeading: true,
 };
 
-const sideBarOptions: VitePressSidebarOptions[] = [
-  {
-    documentRootPath: '/src',
-    scanStartPath: 'buildtools',
-    resolvePath: '/buildtools/',
-  },
-  {
-    documentRootPath: '/src',
-    scanStartPath: 'modules',
-    resolvePath: '/modules/',
-  }
-].map(each => ({
+const sidebarConfigs: Record<string, VitePressSidebarOptions> = {
+  buildtools: {},
+  modules: {},
+  lib: {}
+};
+
+const sideBarOptions = Object.entries(sidebarConfigs).map(([startPath, options]): VitePressSidebarOptions => ({
+  scanStartPath: startPath,
+  resolvePath: `/${startPath}/`,
   ...commonSideBarOptions,
-  ...each,
+  ...options
 }));
 
 export default defineConfig(withSidebar(vitepressOptions, sideBarOptions));
-
-/*
-export default defineConfig({
-
-  themeConfig: {
-    siteTitle: 'SA Modules',
-    // https://vitepress.dev/reference/default-theme-config
-    nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Module Development', link: '/modules' }
-    ],
-
-    sidebar: {
-      '/buildtools/': [
-        {
-          text: 'Build Tools Overview',
-          link: '/buildtools',
-          items: [
-            {
-              text: 'Command Handlers',
-              link: './command'
-            },
-            {
-              text: 'Builders',
-              link: './builders'
-            },
-            {
-              text: 'Prebuild Tasks',
-              link: './prebuild',
-            },
-            {
-              text: 'Testing',
-              link: './testing'
-            },
-            {
-              text: 'Templates',
-              link: './templates'
-            }
-          ]
-        }
-      ],
-      '/buildtools/builders/': [{
-        text: 'Builders',
-        link: '/buildtools/builders',
-        items: [
-          {
-            text: 'Bundles and Tabs',
-            link: './modules'
-          },
-          {
-            text: 'Documentation',
-            link: './docs'
-          },
-          {
-            text: 'Manifest',
-            link: './manifest'
-          }
-        ]
-      }],
-      '/lib/': [{
-        text: 'Modules Libraries',
-        items: [
-          {
-            text: 'ESLint Plugin',
-            link: '/lib/lintplugin'
-          },
-          {
-            text: 'Common Library',
-            link: '/lib/modules-lib/modules'
-          }
-        ]
-      }],
-      '/modules/': [
-        {
-          text: 'Developing Modules',
-          items: [
-            {
-              text: 'Modules Overview',
-              link: '/modules'
-            },
-            {
-              text: 'Getting Started',
-              link: '/modules/getting-started'
-            },
-            {
-              text: 'Unit Testing',
-              link: '/modules/testing'
-            },
-            {
-              text: 'Linting',
-              link: '/modules/linting'
-            },
-            {
-              text: 'Module Contexts',
-              link: '/modules/context'
-            },
-            {
-              text: 'Using the Frontend',
-              link: '/modules/tabs/frontend'
-            },
-            {
-              text: 'Bundles',
-              items: [
-                {
-                  text: 'Bundles Overview',
-                  link: '/modules/bundle'
-                },
-                {
-                  text: 'Creating a Bundle',
-                  link: '/modules/bundle/creating'
-                },
-                {
-                  text: 'Editing a Bundle',
-                  link: '/modules/bundle/editing'
-                },
-                {
-                  text: 'Bundle Documentation',
-                  link: '/modules/bundle/documentation'
-                },
-                {
-                  text: 'Compiling a Bundle',
-                  link: '/modules/bundle/compiling'
-                },
-                {
-                  text: 'Bundle Type Maps',
-                  link: '/modules/bundle/type_map'
-                }
-              ]
-            },
-            {
-              text: 'Tabs',
-              items: [
-                {
-                  text:' Tabs Overview',
-                  link: '/modules/tabs'
-                },
-                {
-                  text: 'Creating a Tab',
-                  link: '/modules/tabs/creating'
-                },
-                {
-                  text: 'Editing a Tab',
-                  link: '/modules/tabs/editing'
-                },
-                {
-                  text: 'Compiling a tab',
-                  link: '/modules/tabs/compiling'
-                },
-                {
-                  text: 'Working with Context',
-                  link: '/modules/tabs/context'
-                },
-                {
-                  text: 'Using the Dev Server',
-                  link: '/modules/tabs/devserver'
-                },
-
-              ]
-            }
-          ]
-        },
-      ]
-    },
-
-    sociallinks: [
-      { icon: 'github', link: _package.repository },
-      {
-        icon: 'gitbook',
-        link: 'https://source-academy.github.io/modules/documentation/'
-      }
-    ],
-    search: {
-      provider: 'local'
-    }
-  }
-});
-*/

docs/src/buildtools/builders/modules.md renamed to docs/src/buildtools/1-builders/1-modules.md

@@ -1,6 +1,3 @@
----
-order: 2
----
 # Building for Bundles and Tabs
 ## Why Bundle?
 To run module code, `js-slang` would have to have all the dependencies of every single module, which would make building it tedious and bloated and also introduce an undesirable dependency between modules and js-slang. Instead, Source Modules are bundled before use.

docs/src/buildtools/builders/docs.md renamed to docs/src/buildtools/1-builders/2-docs.md

@@ -1,7 +1,3 @@
----
-order: 3
----
-
 # Documentation Generation
 
 There are two types of documentation used by Source, which are the jsons and the HTML documentation. Both are built using the [`typedoc`](typedoc.org) tool. By reading comments and type annotations, `typedoc` is able to generate both human readable documentation and documentation in the form of JSON.

docs/src/buildtools/builders/manifest.md renamed to docs/src/buildtools/1-builders/3-manifest.md

@@ -1,7 +1,3 @@
----
-order: 4
----
-
 # The Modules Manifest
 
 Each bundle contains its own manifest. However, after compilation, the manifest remains a separate file that doesn't get included with the bundle's compiled code.

docs/src/buildtools/1-builders/index.md

@@ -0,0 +1,9 @@
+---
+title: Builders
+---
+# Builders Overview
+The following pages contains information on how each asset type is produced
+
+- [Bundles and Tabs](./1-modules.md)
+- [Documentation](./2-docs)
+- [Manifest](./3-manifest)

docs/src/buildtools/command.md renamed to docs/src/buildtools/2-command.md

@@ -1,7 +1,3 @@
----
-order: 2
----
-
 # Command Handlers
 Command Line parsing is handled by the [`commander`](https://github.com/tj/commander.js) library.
 

docs/src/buildtools/structure.md renamed to docs/src/buildtools/3-structure.md

@@ -1,3 +1,22 @@
 ---
 title: Build Tools
 ---
+
+# Build Tools Overview
+
+The Source Academy Modules build tools are written in Typescript and designed to be run from the command line
+
+The build tools are comprised of several sections:
+
+- [Command Handlers](./command)
+  - The actual code that runs command line argument parsing
+- [Builders](./1-builders)
+  - The code that converts a bundle or tab into its outputs
+- [Prebuild Tasks](./prebuild)
+  - Code that is intended to be run before builders
+- [Testing](./testing)
+  - Code for integrating `vitest`
+- [Templates](./templates)
+  - Code for the template command
+
+Explanations on how the build tools repository has been structured can be found [here](./structure)