Skip to content

Commit 5ce950d

Browse files
authored
Fix incorrect documentation URL references (#483)
1 parent ed1fe71 commit 5ce950d

File tree

2 files changed

+7
-12
lines changed

2 files changed

+7
-12
lines changed

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The [Source Academy](https://sourceacademy.org) and [Source Academy @ NUS](https
88

99
If you are looking for the documentation for the default modules, that can be found [here](https://source-academy.github.io/modules/documentation).
1010

11-
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).
11+
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).
1212

1313
## Quick Links
1414

@@ -17,7 +17,7 @@ If you are a developer looking to do things like create a new bundle or work wit
1717
| Source Academy | <https://sourceacademy.org> |
1818
| Default Modules Deployment | <https://source-academy.github.io/modules> |
1919
| Default Modules Documentation | <https://source-academy.github.io/modules/documentation> |
20-
| Developer Documentation | <https://source-academy.github.io/devdocs> |
20+
| Developer Documentation | <https://source-academy.github.io/modules/devdocs> |
2121
| `js-slang` | <https://github.com/source-academy/js-slang> |
2222
| Frontend | <https://github.com/source-academy/frontend> |
2323

@@ -31,18 +31,12 @@ If you are a developer looking to do things like create a new bundle or work wit
3131
├── build // Output for compiled assets
3232
├── devserver // Development Server
3333
├── docs // Documentation Server
34-
├── lib
35-
│ ├── __test_mocks__ // Mock bundles and tabs used for testing
36-
│ ├── buildtools // Command line tools for bundles and tabs
37-
│ ├── lintplugin // ESLint Plugin
38-
│ ├── markdown-tree // Markdown-It plugin for generating directory trees
39-
│ ├── modules-lib // Common library for utilities used by bundles and tabs
40-
│ └── repotools // Repository wide tooling
34+
├── lib // Common libraries used throughout the repo
4135
├── src // Code for bundles, tabs and java-slang
4236
│ ├── bundles
4337
│ ├── tabs
4438
│ └── java
45-
├── vitest.config.js // Root Vitest Config
39+
├── vitest.config.ts // Root Vitest Config
4640
├── eslint.config.js // ESLint Config
4741
└── yarn.config.cjs // Yarn Constraints file
4842
```

docs/.vitepress/config.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ import _package from '../../package.json' with { type: 'json' };
1010

1111
// https://vitepress.dev/reference/site-config
1212
const vitepressOptions: UserConfig = {
13-
base: '/devdocs/',
13+
base: '/modules/devdocs/',
1414
description: 'Developer documentation for the Source Academy modules repository',
15-
head: [['link', { rel: 'icon', href: '/devdocs/favicon.ico' }]],
15+
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
1616
ignoreDeadLinks: 'localhostLinks',
1717
lastUpdated: true,
1818
markdown: {
@@ -99,6 +99,7 @@ const vitepressOptions: UserConfig = {
9999
}
100100
},
101101
vite: {
102+
// @ts-expect-error groupIconVitePlugin is probably built for an incorrect version of Vite
102103
plugins: [groupIconVitePlugin()]
103104
}
104105
};

0 commit comments

Comments
 (0)