Skip to content

Commit 5473892

Browse files
fhammerschmidtfhammerschmidt
committed
Update manual page links to versioned ones
1 parent 456ce77 commit 5473892

File tree

125 files changed

+168
-182
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+168
-182
lines changed

‎pages/docs/manual/v11.0.0/api/[...slug].js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ import {
66
import APIDocs from "src/ApiDocs.mjs";
77

88
export async function getStaticProps(ctx) {
9-
return await getStaticPropsByVersion({ ...ctx, version: "latest" });
9+
return await getStaticPropsByVersion({ ...ctx, version: "v11.0.0" });
1010
}
1111

1212
export async function getStaticPaths(ctx) {
13-
return await getStaticPathsByVersion("latest");
13+
return await getStaticPathsByVersion("v11.0.0");
1414
}
1515

1616
export default function Comp(props) {

‎pages/docs/manual/v11.0.0/array-and-list.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Array & List"
33
description: "Arrays and List data structures"
4-
canonical: "/docs/manual/latest/array-and-list"
4+
canonical: "/docs/manual/v11.0.0/array-and-list"
55
---
66

77
# Array and List

‎pages/docs/manual/v11.0.0/async-await.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Async / Await"
33
description: "Async / await for asynchronous operations"
4-
canonical: "/docs/manual/latest/async-await"
4+
canonical: "/docs/manual/v11.0.0/async-await"
55
---
66

77
<!-- This prelude is used in many different followup examples, so we use it to shorten the noise of the example code. -->

‎pages/docs/manual/v11.0.0/attribute.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Attribute (Decorator)"
33
description: "Annotations in ReScript"
4-
canonical: "/docs/manual/latest/attribute"
4+
canonical: "/docs/manual/v11.0.0/attribute"
55
---
66

77
# Attribute (Decorator)

‎pages/docs/manual/v11.0.0/bind-to-global-js-values.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Bind to Global JS Values"
33
description: "JS interop with global JS values in ReScript"
4-
canonical: "/docs/manual/latest/bind-to-global-js-values"
4+
canonical: "/docs/manual/v11.0.0/bind-to-global-js-values"
55
---
66

77
# Bind to Global JS Values

‎pages/docs/manual/v11.0.0/bind-to-js-function.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Bind to JS Function"
33
description: "JS interop with functions in ReScript"
4-
canonical: "/docs/manual/latest/bind-to-js-function"
4+
canonical: "/docs/manual/v11.0.0/bind-to-js-function"
55
---
66

77
# Function

‎pages/docs/manual/v11.0.0/bind-to-js-object.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Bind to JS Object"
33
description: "Interop with JS objects in ReScript"
4-
canonical: "/docs/manual/latest/bind-to-js-object"
4+
canonical: "/docs/manual/v11.0.0/bind-to-js-object"
55
---
66

77
# Bind to JS Object

‎pages/docs/manual/v11.0.0/browser-support-polyfills.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Browser Support & Polyfills"
33
description: "Note on browser support in ReScript"
4-
canonical: "/docs/manual/latest/browser-support-polyfills"
4+
canonical: "/docs/manual/v11.0.0/browser-support-polyfills"
55
---
66

77
# Browser Support & Polyfills

‎pages/docs/manual/v11.0.0/build-configuration-schema.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Configuration Schema"
33
metaTitle: "Build System Configuration Schema"
44
description: "Schema exploration widget for the ReScript configuration file"
5-
canonical: "/docs/manual/latest/build-configuration-schema"
5+
canonical: "/docs/manual/v11.0.0/build-configuration-schema"
66
---
77

88
import dynamic from "next/dynamic";

‎pages/docs/manual/v11.0.0/build-configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Configuration"
33
metaTitle: "Build System Configuration"
44
description: "Details about the configuration of the ReScript build system (rescript.json)"
5-
canonical: "/docs/manual/latest/build-configuration"
5+
canonical: "/docs/manual/v11.0.0/build-configuration"
66
---
77

88
# Configuration

‎pages/docs/manual/v11.0.0/build-external-stdlib.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "External Stdlib"
33
metaTitle: "External Stdlib"
44
description: "Configuring an external ReScript stdlib package"
5-
canonical: "/docs/manual/latest/build-external-stdlib"
5+
canonical: "/docs/manual/v11.0.0/build-external-stdlib"
66
---
77

88
# External Stdlib

‎pages/docs/manual/v11.0.0/build-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Overview"
33
metaTitle: "Build System Overview"
44
description: "Documentation about the ReScript build system and its toolchain"
5-
canonical: "/docs/manual/latest/build-overview"
5+
canonical: "/docs/manual/v11.0.0/build-overview"
66
---
77

88
# Build System Overview

‎pages/docs/manual/v11.0.0/build-performance.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Performance"
33
metaTitle: "Build Performance"
44
description: "ReScript build performance and measuring tools"
5-
canonical: "/docs/manual/latest/build-performance"
5+
canonical: "/docs/manual/v11.0.0/build-performance"
66
---
77

88
# Build Performance
@@ -21,7 +21,11 @@ Run the above command at your ReScript project's root; it'll spit out a JSON fil
2121

2222
import Image from "src/components/Image";
2323

24-
<Image withShadow={true} src="/static/img/bstracing.png" caption="Screenshot of bstracing result"/>
24+
<Image
25+
withShadow={true}
26+
src="/static/img/bstracing.png"
27+
caption="Screenshot of bstracing result"
28+
/>
2529

2630
## Under the Hood
2731

‎pages/docs/manual/v11.0.0/build-pinned-dependencies.mdx

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Pinned Dependencies"
33
metaTitle: "Pinned Dependencies"
44
description: "Handling multiple packages within one ReScript project with pinned dependencies"
5-
canonical: "/docs/manual/latest/build-pinned-dependencies"
5+
canonical: "/docs/manual/v11.0.0/build-pinned-dependencies"
66
---
77

88
# Pinned Dependencies
@@ -26,6 +26,7 @@ Whenever a package is being built (`rescript build`), the build system will buil
2626
The build system respects the following rules for each package type:
2727

2828
**Toplevel**
29+
2930
- Warnings reported
3031
- Warn-error respected
3132
- Builds dev dependencies
@@ -34,13 +35,15 @@ The build system respects the following rules for each package type:
3435
- Package-specs like JavaScript module or CommonJS overrides all its dependencies
3536

3637
**Pinned dependencies**
38+
3739
- Warnings reported
3840
- Warn-error respected
3941
- Ignores pinned dependencies
4042
- Builds dev dependencies
4143
- Runs custom rules
4244

4345
**Normal dependencies**
46+
4447
- Warnings, warn-error ignored
4548
- Ignores dev directories
4649
- Ignores pinned dependencies
@@ -75,32 +78,24 @@ Our `package.json` file within our codebase root would look like this:
7578
"name": "myproject",
7679
"private": true,
7780
"workspaces": {
78-
"packages": [
79-
"app",
80-
"common",
81-
"myplugin"
82-
]
81+
"packages": ["app", "common", "myplugin"]
8382
}
8483
}
8584
```
8685

87-
8886
Our `app` folder would be our toplevel package, consuming our `common` and `myplugin` packages as `pinned-dependencies`. The configuration for `app/rescript.json` looks like this:
8987

9088
```json
9189
{
9290
"name": "app",
9391
"version": "1.0.0",
9492
"sources": {
95-
"dir" : "src",
96-
"subdirs" : true
93+
"dir": "src",
94+
"subdirs": true
9795
},
9896
/* ... */
99-
"bs-dependencies": [
100-
"common",
101-
"myplugin"
102-
],
103-
"pinned-dependencies": ["common", "myplugin"],
97+
"bs-dependencies": ["common", "myplugin"],
98+
"pinned-dependencies": ["common", "myplugin"]
10499
/* ... */
105100
}
106101
```

‎pages/docs/manual/v11.0.0/control-flow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "If-Else & Loops"
33
description: "If, else, ternary, for, and while"
4-
canonical: "/docs/manual/latest/control-flow"
4+
canonical: "/docs/manual/v11.0.0/control-flow"
55
---
66

77
# If-Else & Loops

‎pages/docs/manual/v11.0.0/converting-from-js.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Converting from JS"
33
description: "How to convert to ReScript with an existing JS codebase"
4-
canonical: "/docs/manual/latest/converting-from-js"
4+
canonical: "/docs/manual/v11.0.0/converting-from-js"
55
---
66

77
# Converting from JS

‎pages/docs/manual/v11.0.0/editor-plugins.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Editor Plugins"
33
description: "List of ReScript editor plugins"
4-
canonical: "/docs/manual/latest/editor-plugins"
4+
canonical: "/docs/manual/v11.0.0/editor-plugins"
55
---
66

77
# Editor Plugins

‎pages/docs/manual/v11.0.0/embed-raw-javascript.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Embed Raw JavaScript"
33
description: "Utility syntax to for raw JS usage in ReScript"
4-
canonical: "/docs/manual/latest/embed-raw-javascript"
4+
canonical: "/docs/manual/v11.0.0/embed-raw-javascript"
55
---
66

77
# Embed Raw JavaScript

‎pages/docs/manual/v11.0.0/equality-comparison.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Equality and Comparison"
33
description: "Handling equality and comparison checks"
4-
canonical: "/docs/manual/latest/equality-comparison"
4+
canonical: "/docs/manual/v11.0.0/equality-comparison"
55
---
66

77
# Equality and Comparison

‎pages/docs/manual/v11.0.0/exception.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Exception"
33
description: "Exceptions and exception handling in ReScript"
4-
canonical: "/docs/manual/latest/exception"
4+
canonical: "/docs/manual/v11.0.0/exception"
55
---
66

77
# Exception

‎pages/docs/manual/v11.0.0/extensible-variant.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Extensible Variant"
33
description: "Extensible Variants in ReScript"
4-
canonical: "/docs/manual/latest/extensible-variant"
4+
canonical: "/docs/manual/v11.0.0/extensible-variant"
55
---
66

77
# Extensible Variant

‎pages/docs/manual/v11.0.0/external.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "External (Bind to Any JS Library)"
33
description: "The external keyword"
4-
canonical: "/docs/manual/latest/external"
4+
canonical: "/docs/manual/v11.0.0/external"
55
---
66

77
# External (Bind to Any JS Library)

‎pages/docs/manual/v11.0.0/faq.mdx

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "FAQ"
33
description: "Frequently asked questions about ReScript and its ecosystem"
4-
canonical: "/docs/manual/latest/faq"
4+
canonical: "/docs/manual/v11.0.0/faq"
55
---
66

77
# Frequently Asked Questions
@@ -10,23 +10,20 @@ canonical: "/docs/manual/latest/faq"
1010

1111
We aim to provide the best typed language experience for the JavaScript platform.
1212

13-
1413
**What’s the relationship with BuckleScript?**
1514

1615
BuckleScript is ReScript's old branding, with a sharper focus on proper JS support and familiarity which we previously couldn't achieve to the degree we wanted, due to us needing to cater to various different crowds.
1716

1817
**What’s ReScript's relationship with OCaml?**
1918

20-
We reuse and adjust the excellent type system and lots of other high quality components from OCaml for JS experience.
21-
Additionally, ReScript provides its own syntax, build system, IDE, backend, JS interop, extra language features, etc.
19+
We reuse and adjust the excellent type system and lots of other high quality components from OCaml for JS experience.
20+
Additionally, ReScript provides its own syntax, build system, IDE, backend, JS interop, extra language features, etc.
2221

23-
The ReScript toolchain is developed using OCaml, however, the version of ReScript is decoupled against the version of OCaml,
22+
The ReScript toolchain is developed using OCaml, however, the version of ReScript is decoupled against the version of OCaml,
2423
ReScript compiler should build against any reasonable modern version of OCaml compiler.
2524

2625
For the majority of ReScript users, they don't need to learn OCaml or use OCaml toolchain to be productive in ReScript.
2726

28-
29-
3027
**What’s the relationship with Reason?**
3128

3229
See [here](/blog/bucklescript-is-rebranding). Reason is a syntax layer for OCaml that BuckleScript also adopted. The current ReScript compiler also supports the old Reason syntax v3.6 for backward compatibility. We will support it for a long time to make sure existing users do not get breaking changes.

‎pages/docs/manual/v11.0.0/function.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Function"
33
description: "Function syntax in ReScript"
4-
canonical: "/docs/manual/latest/function"
4+
canonical: "/docs/manual/v11.0.0/function"
55
---
66

77
# Function

‎pages/docs/manual/v11.0.0/generate-converters-accessors.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Generate Converters & Helpers"
33
description: "All about the @deriving decorator, and how to generate code from types"
4-
canonical: "/docs/manual/latest/generate-converters-accessors"
4+
canonical: "/docs/manual/v11.0.0/generate-converters-accessors"
55
---
66

77
# Generate Converters & Helpers

‎pages/docs/manual/v11.0.0/import-export.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Import & Export"
33
description: "Importing / exporting in ReScript modules"
4-
canonical: "/docs/manual/latest/import-export"
4+
canonical: "/docs/manual/v11.0.0/import-export"
55
---
66

77
# Import & Export

‎pages/docs/manual/v11.0.0/import-from-export-to-js.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Import from / Export to JS"
33
description: "Importing / exporting JS module content in ReScript"
4-
canonical: "/docs/manual/latest/import-from-export-to-js"
4+
canonical: "/docs/manual/v11.0.0/import-from-export-to-js"
55
---
66

77
# Import from/Export to JS

‎pages/docs/manual/v11.0.0/inlining-constants.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Inlining Constants"
33
description: "Inlining constants"
4-
canonical: "/docs/manual/latest/inlining-constants"
4+
canonical: "/docs/manual/v11.0.0/inlining-constants"
55
---
66

77
# Inlining Constants

‎pages/docs/manual/v11.0.0/installation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Installation"
33
description: "ReScript installation and setup instructions"
4-
canonical: "/docs/manual/latest/installation"
4+
canonical: "/docs/manual/v11.0.0/installation"
55
---
66

77
# Installation
@@ -144,7 +144,7 @@ Since ReScript compiles to clean readable JS files, the rest of your existing to
144144

145145
Helpful guides:
146146

147-
- [Converting from JS](converting-from-js).
147+
- [Converting from JS](/docs/manual/latest/converting-from-js).
148148
- [Shared Data Types](shared-data-types).
149149
- [Import from/Export to JS](import-from-export-to-js).
150150

‎pages/docs/manual/v11.0.0/interop-cheatsheet.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Interop Cheatsheet"
33
description: "Cheatsheet for various interop scenarios in ReScript"
4-
canonical: "/docs/manual/latest/interop-cheatsheet"
4+
canonical: "/docs/manual/v11.0.0/interop-cheatsheet"
55
---
66

77
# Interop Cheatsheet

‎pages/docs/manual/v11.0.0/interop-with-js-build-systems.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Interop with JS Build Systems"
33
description: "Documentation on how to interact with existing JS build systems"
4-
canonical: "/docs/manual/latest/interop-with-js-build-systems"
4+
canonical: "/docs/manual/v11.0.0/interop-with-js-build-systems"
55
---
66

77
# Interop with JS Build Systems

0 commit comments

Comments
 (0)