diff --git a/README.md b/README.md index 6d091cd44..54ead725f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The [Source Academy](https://sourceacademy.org) and [Source Academy @ NUS](https 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). +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/modules/devdocs). ## Quick Links @@ -17,7 +17,7 @@ If you are a developer looking to do things like create a new bundle or work wit | Source Academy | | | Default Modules Deployment | | | Default Modules Documentation | | -| Developer Documentation | | +| Developer Documentation | | | `js-slang` | | | Frontend | | @@ -31,18 +31,12 @@ If you are a developer looking to do things like create a new bundle or work wit ├── build // Output for compiled assets ├── devserver // Development Server ├── docs // Documentation Server -├── lib -│ ├── __test_mocks__ // Mock bundles and tabs used for testing -│ ├── buildtools // Command line tools for bundles and tabs -│ ├── lintplugin // ESLint Plugin -│ ├── markdown-tree // Markdown-It plugin for generating directory trees -│ ├── modules-lib // Common library for utilities used by bundles and tabs -│ └── repotools // Repository wide tooling +├── lib // Common libraries used throughout the repo ├── src // Code for bundles, tabs and java-slang │ ├── bundles │ ├── tabs │ └── java -├── vitest.config.js // Root Vitest Config +├── vitest.config.ts // Root Vitest Config ├── eslint.config.js // ESLint Config └── yarn.config.cjs // Yarn Constraints file ``` diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 7b7cf763c..dd9286916 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -10,9 +10,9 @@ import _package from '../../package.json' with { type: 'json' }; // https://vitepress.dev/reference/site-config const vitepressOptions: UserConfig = { - base: '/devdocs/', + base: '/modules/devdocs/', description: 'Developer documentation for the Source Academy modules repository', - head: [['link', { rel: 'icon', href: '/devdocs/favicon.ico' }]], + head: [['link', { rel: 'icon', href: '/favicon.ico' }]], ignoreDeadLinks: 'localhostLinks', lastUpdated: true, markdown: { @@ -99,6 +99,7 @@ const vitepressOptions: UserConfig = { } }, vite: { + // @ts-expect-error groupIconVitePlugin is probably built for an incorrect version of Vite plugins: [groupIconVitePlugin()] } };