Skip to content

Commit d5081a7

Browse files
Update gentype intro
1 parent 782a27b commit d5081a7

File tree

3 files changed

+8
-19
lines changed

3 files changed

+8
-19
lines changed

Diff for: data/sidebar_manual_latest.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,11 @@
5555
],
5656
"TypeScript Interop": [
5757
"gentype-introduction",
58-
"gentype-getting-started",
5958
"gentype-usage",
60-
"gentype-supported-types"
59+
"gentype-supported-types",
60+
"bind-to-ts-object",
61+
"bind-to-ts-primitive",
62+
"bind-to-ts-variant"
6163
],
6264
"Build System": [
6365
"build-overview",

Diff for: next.config.mjs

+3-3
Original file line numberDiff line numberDiff line change
@@ -109,17 +109,17 @@ const config = {
109109
},
110110
{
111111
source: "/docs/gentype/latest/getting-started",
112-
destination: "/docs/manual/latest/gentype-getting-started",
112+
destination: "/docs/manual/latest/gentype-introduction",
113113
permanent: true,
114114
},
115115
{
116116
source: "/docs/gentype/latest/usage",
117-
destination: "/docs/manual/latest/gentype-usage",
117+
destination: "/docs/manual/latest/gentype-introduction",
118118
permanent: true,
119119
},
120120
{
121121
source: "/docs/gentype/latest/supported-types",
122-
destination: "/docs/manual/latest/gentype-supported-types",
122+
destination: "/docs/manual/latest/gentype-introduction",
123123
permanent: true,
124124
},
125125
];

Diff for: pages/docs/manual/latest/gentype-introduction.mdx

+1-14
Original file line numberDiff line numberDiff line change
@@ -91,21 +91,8 @@ const App = () => {
9191
};
9292
```
9393

94-
That's it for our quick example.
95-
96-
For detailed information, head to the [Getting Started](/docs/manual/latest/gentype-getting-started) or [Usage](/docs/manual/latest/gentype-usage) section.
97-
9894
## Setup
9995

100-
Since compiler v10.1, there's no need to install anything. For compiler 10.0 or older, install the binaries via `npm` (or `yarn`):
101-
102-
```
103-
npm install gentype --save-dev
104-
105-
# Verify installed gentype binary
106-
npx gentype --help
107-
```
108-
10996
Add a `gentypeconfig` section to your `rescript.json` (See [Configuration](#configuration) for details):
11097

11198
```json
@@ -189,6 +176,6 @@ These features are for experimentation only. They could be changed/removed any t
189176

190177
## Limitations
191178

192-
- **in-source = true**. Currently only supports ReScript projects with [in-source generation](/docs/manual/latest/build-configuration#package-specs) and `.bs.js` file suffix.
179+
- **in-source = true**. Currently only supports ReScript projects with [in-source generation](/docs/manual/latest/build-configuration#package-specs) and file suffixes that end on `.js`, like `.res.js` or `.bs.js`.
193180

194181
- **Limited namespace support**. Currently there's limited [namespace](/docs/manual/latest/build-configuration#name-namespace) support, and only `namespace:true` is possible, not e.g. `namespace:"custom"`.

0 commit comments

Comments
 (0)