Change document configurations

Author: leeyi45

docs/.gitignore

@@ -1,2 +1,4 @@
 .vitepress/cache
 .vitepress/dist
+
+src/lib/modules-lib

docs/.vitepress/config.ts

@@ -12,7 +12,9 @@ const vitepressOptions: UserConfig = {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Module Development', link: '/modules/' }
+      { text: 'Module Development', link: '/modules/' },
+      { text: 'Common Library', link: '/lib' },
+      { text: 'Build Tools', link: '/buildtools' }
     ],
     siteTitle: 'SA Modules',
     socialLinks: [
@@ -25,7 +27,7 @@ const vitepressOptions: UserConfig = {
     search: {
       provider: 'local'
     }
-  }
+  },
 };
 
 const commonSideBarOptions: VitePressSidebarOptions = {
@@ -43,7 +45,8 @@ const commonSideBarOptions: VitePressSidebarOptions = {
 const sidebarConfigs: Record<string, VitePressSidebarOptions> = {
   buildtools: {},
   modules: {},
-  lib: {}
+  lib: {},
+  '/lib/modules-lib': {}
 };
 
 const sideBarOptions = Object.entries(sidebarConfigs).map(([startPath, options]): VitePressSidebarOptions => ({

docs/package.json

@@ -9,8 +9,8 @@
     "vitepress-sidebar": "^1.31.1"
   },
   "scripts": {
-    "docs:dev": "vitepress dev .",
-    "docs:build": "vitepress build .",
-    "docs:preview": "vitepress preview ."
+    "build": "vitepress build .",
+    "dev": "vitepress dev .",
+    "preview": "vitepress preview ."
   }
 }

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

@@ -36,7 +36,7 @@ Bundles and tabs are transpiled with esbuild using the following common options
 
 <<< ../../../../lib/buildtools/src/build/modules/commons.ts#esbuildOptions
 
-## Options Explained:
+## Options Explained
 ### `bundle: true`
 Tell `esbuild` to bundle the code into a single file.
 
@@ -94,7 +94,7 @@ var module = (function() {
 ```
 Which are then transformed by the `outputBundleOrTab` function, which produces output that looks like this:
 ```js
-require => {
+export default require => {
   var exports = {}
   exports.add_one = function(x) {
     return x + 1;
@@ -104,7 +104,8 @@ require => {
 }
 ```
 
-When bundles and tabs are loaded, the IIFE is called with a function that simulates the `require()` function in CommonJS to provide the dependencies marked as external (that have to be provided at runtime).
+Consumers of this compiled version of bundles and tabs can retrieve the IIFE by using the default export.  When bundles and tabs are loaded, the IIFE is called with a function that simulates the `require()` function
+in CommonJS to provide the dependencies marked as external (that have to be provided at runtime).
 
 ## `js-slang/context`
 `js-slang/context` is an import provided at runtime by `js-slang` that returns the context in use for evaluation. It is not an actual import that's available

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

@@ -1,6 +1,6 @@
 # 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.
+There are two types of documentation used by Source, which are the jsons and the HTML documentation. Both are built using the [`typedoc`](https://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.
 
 ## Typedoc Overview
 Typedoc has been configured to use the [`package` entry point strategy](https://typedoc.org/documents/Options.Input.html#packages). To make sure that each bundle's documentation is generated with the proper name, each bundle's `tsconfig.json` contains

docs/src/buildtools/3-structure.md

@@ -1,7 +1,3 @@
----
-order: 3
----
-
 # General Design of the Build Tools
 
 ## Path Resolution

docs/src/buildtools/index.md

@@ -8,7 +8,7 @@ The Source Academy Modules build tools are written in Typescript and designed to
 
 The build tools are comprised of several sections:
 
-- [Command Handlers](./command)
+- [Command Handlers](./2-command)
   - The actual code that runs command line argument parsing
 - [Builders](./1-builders)
   - The code that converts a bundle or tab into its outputs