Skip to content

Commit 208fb28

Browse files
committed
Fix broken links
1 parent 22bbf6d commit 208fb28

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

docs/src/modules/2-bundle/5-documentation/1-cadet/1-cadet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Since modules are already written in Typescript, there is no need to use type-aw
2727
All type annotations should be written in directly Typescript
2828
so as not to confuse Typedoc and ensure that the Typescript compiler is able to ensure type safety.
2929

30-
If you do need to the type of an export to be documented differently from its type in Typescript source code, you can use a [type map](../7-type_map).
30+
If you do need to the type of an export to be documented differently from its type in Typescript source code, you can use a [type map](../../7-type_map).
3131
:::
3232

3333
Let us look at more examples from the `curve` module.

docs/src/modules/2-bundle/5-documentation/2-dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ the entire documentation server to read it).
3131

3232
If you have more complex documentation needs, you can follow the instructions in the next section.
3333

34-
### 2. As a collection of Markdown files located [here](../../../lib/dev):
34+
### 2. As a collection of Markdown files located [here](../../../lib/dev/index):
3535

3636
Within the `dev` folder, each markdown file/folder structure represents a separate bundle.
3737

docs/src/modules/2-bundle/5-documentation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ title: Bundle Documentation
44

55
Contents of this section
66

7-
- [Cadet Documentation](./1-cadet)
7+
- [Cadet Documentation](./1-cadet/1-cadet)
88
- [Developer Documentation](./2-dev)

docs/src/modules/2-bundle/7-type_map.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Regardless of the situation, type maps are a way for bundle authors to control t
1111
> Currently `js-slang` only performs any kind of type checking for modules when the typed Source variant is used.
1212
> This means that type maps are only used by the typed Source Variant.
1313
>
14-
> This also means that documentation (mentioned [here](./5-documentation/5-documentation)) will not reflect the types specified by the type map
14+
> This also means that documentation (mentioned [here](./5-documentation/1-cadet/1-cadet)) will not reflect the types specified by the type map
1515
1616
Type Maps are opt-in. If the bundle does not provide a type map, then no type checking is performed on its exports, similar to
1717
how `skipLibCheck: true` is used in Typescript.
@@ -101,7 +101,7 @@ export const translate = RuneFunctions.translate;
101101
> Notice that when re-exporting, the documentation is attached to the constant declaration and not the declaration in the class. This is so that
102102
> the documentation is properly applied to the exported function.
103103
>
104-
> Also notice that the `@function` tag has been applied. More information about why this is necessary can be found [here](./5-documentation/5-documentation#use-of-function)
104+
> Also notice that the `@function` tag has been applied. More information about why this is necessary can be found [here](./5-documentation/1-cadet/1-cadet#use-of-function)
105105
>
106106
> A quick way to check if you have written your documentation correctly is to see if IntelliSense in VSCode is able to display it to you.
107107

0 commit comments

Comments
 (0)