Miscellanous changes

Author: leeyi45

.github/actions/vitest.setup.ts

@@ -1,28 +1,3 @@
-import type { summary } from '@actions/core';
 import { vi } from 'vitest';
 
-vi.mock(import('@actions/core'), async importOriginal => {
-  const original = await importOriginal();
-  const outputObject: Record<string, any> = {};
-
-  const summaryObject: typeof summary = {
-    addList() { return this; },
-    addHeading() { return this; },
-    write() {
-      return Promise.resolve(this);
-    }
-  } as any;
-
-  return {
-    ...original,
-    info: vi.fn(console.info),
-    error: vi.fn(console.error),
-    outputObject,
-    setOutput: (p, v) => {
-      outputObject[p] = JSON.stringify(v);
-    },
-    summary: summaryObject
-  };
-});
-
 vi.mock(import('@actions/exec'));

README.md

@@ -6,40 +6,24 @@ This repository contains the default modules of the Source Academy and their doc
 
 The [Source Academy](https://sourceacademy.org) and [Source Academy @ NUS](https://sourceacademy.nus.edu.sg) are configured to access the default module site when evaluating `import` directives.
 
+If you are looking for the documentation for the default modules, that can be found [here](https://source-academy.github.io/modules/documentation).
+
+If you are a developer looking to do things like create a new bundle or work with the repository, the developer documentation can be found [here](https://source-academy.github.io/devdocs).
+
 ## Quick Links
+
 | Site | Link |
 | ---- | ---- |
 | Source Academy | https://sourceacademy.org |
 | Default Modules Deployment | https://source-academy.github.io/modules |
 | Default Modules Documentation | https://source-academy.github.io/modules/documentation |
-| Developer Wiki | https://github.com/source-academy/modules/wiki |
+| Developer Documentation | https://source-academy.github.io/devdocs |
 | `js-slang` | https://github.com/source-academy/js-slang |
 | Frontend | https://github.com/source-academy/frontend |
 
-If you are looking for the documentation for the default modules, they can be found [here](https://source-academy.github.io/modules/documentation).
-
-If you are a developer working with this repository, the developer documentation can be found [here](https://github.com/source-academy/modules/wiki)
-
-## Repository Structure
-The repository is designed as a monorepo, managed using Yarn workspaces.
-
-```txt
-.
-├── .github            // Configuration for issue templates and workflows
-├── .husky             // Configuration for code that runs on Git Hooks
-├── .vscode            // Configuration for VSCode integration
-├── build              // Output directory for compiled assets
-├── devserver          // Modules Development Server
-├── docs               // Developer Documentation and Server
-├── lib                
-│   ├── buildtools     // Scripts for compiling bundles and tabs
-│   ├── lintplugin     // ESLint Plugin for SA Modules
-│   └── modules-lib    // Common utilities and React components for SA Modules
-├── src
-│   ├── bundles        // Source code for Bundles
-│   ├── tabs           // Source code for Tabs
-│   └── java           // Assets for Source Java
-├── eslint.config.js   // ESLint configuration for the entire repository
-├── vitest.config.js   // Vitest configuration for the entire repository
-└── yarn.config.cjs    // Yarn constraints configuration
-```
+## Building the documentation server
+
+1. Run the command: `yarn workspaces focus @sourceacademy/modules-docserver`
+2. `cd` into the `docs` directory and run `yarn dev`.
+
+You should now have a local copy of the modules' developer documentation running on your machine.

docs/src/modules/1-getting-started/2-start.md

@@ -10,6 +10,10 @@ A stable version of [NodeJS](https://nodejs.org/en/) is required on your local d
 
 You can use [nvm](https://github.com/creationix/nvm#installation) _(macOS/Linux)_ or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) _(windows)_ to switch Node versions between different projects.
 
+> [!INFO]
+> The tooling in the repository is intended to work with both Posix-Compliant systems (macOS/Linux/WSL) _and_ Windows.
+> If you encounter any compatibility issues do open an issue with the respository.
+
 ## 2. Clone this Repository
 
 Clone the modules repository to your local machine using `git` or your tool of choice.

docs/src/modules/2-bundle/6-compiling.md

@@ -25,7 +25,7 @@ yarn build --tsc
 This will run the TypeScript compiler before compiling your bundle. If there are any type errors, it will be displayed in the command line
 and your bundle will not be compiled.
 
-The output for your bundle will be placed at `/build/bundles/[your_bundle_name].js`.
+The output for your bundle will be placed at `build/bundles/[your_bundle_name].js`.
 
 ## For Other Bundles
 

docs/src/modules/4-testing/1-desktop.md

@@ -7,7 +7,10 @@ You will need to change which module backend is in use using the `--modulesBacke
 
 If your package already depends on `js-slang`, then you can already run `js-slang` from the command line using `yarn js-slang`.
 
-If not, you can either add `js-slang` to your dev dependencies, or you can install the root repository package.
+If not, you can either:
+- Add `js-slang` to your dev dependencies
+- Install the root repository package.
+- Use the [`yarn dlx` command](https://yarnpkg.com/cli/dlx)
 
 ## The Modules Server
 

eslint.config.js

@@ -118,7 +118,6 @@ export default tseslint.config(
       }
     }
   },
-
   {
     extends: [js.configs.recommended],
     name: 'Global JS/TS Stylistic Rules',

yarn.config.cjs

@@ -31,5 +31,12 @@ module.exports = defineConfig({
         dep.update('workspace:^');
       }
     }
+
+    // Repotools should not be allowed to depend on any other packages in this
+    // repository
+    const [repotools] = Yarn.workspaces({ ident: '@sourceacademy/modules-repotools' });
+    for (const dep of Yarn.dependencies({ workspace: repotools })) {
+      if (dep.ident.startsWith('@sourceacademy/modules')) dep.update(undefined);
+    }
   }
 });