diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md index 7c41dff6..fd04f617 100644 --- a/guide/src/SUMMARY.md +++ b/guide/src/SUMMARY.md @@ -4,15 +4,17 @@ -------------------------------------------------------------------------------- -- [Basic Usage](./basic-usage.md) -- [What Just Happened?](./what-just-happened.md) -- [What Else Can We Do?](./what-else-can-we-do.md) -- [Closures](./closures.md) -- [No ES Modules](./no-esm.md) -- [Passing Arbitrary data](./passing-data.md) -- [Feature Reference](./feature-reference.md) -- [CLI Reference](./cli-reference.md) -- [Type Reference](./reference.md) +- [Whirlwind Tour](./whirlwind-tour/introduction.md) + - [Basic Usage](./whirlwind-tour/basic-usage.md) + - [What Just Happened?](./whirlwind-tour/what-just-happened.md) + - [What Else Can We Do?](./whirlwind-tour/what-else-can-we-do.md) +- [Reference](./reference/index.md) + - [Closures](./reference/closures.md) + - [No ES Modules](./reference/no-esm.md) + - [Passing Arbitrary data](./reference/passing-data.md) + - [Feature Reference](./reference/feature-reference.md) + - [CLI Reference](./reference/cli-reference.md) + - [Type Reference](./reference/reference.md) -------------------------------------------------------------------------------- diff --git a/guide/src/cli-reference.md b/guide/src/reference/cli-reference.md similarity index 100% rename from guide/src/cli-reference.md rename to guide/src/reference/cli-reference.md diff --git a/guide/src/closures.md b/guide/src/reference/closures.md similarity index 100% rename from guide/src/closures.md rename to guide/src/reference/closures.md diff --git a/guide/src/feature-reference.md b/guide/src/reference/feature-reference.md similarity index 100% rename from guide/src/feature-reference.md rename to guide/src/reference/feature-reference.md diff --git a/guide/src/reference/index.md b/guide/src/reference/index.md new file mode 100644 index 00000000..58d5627a --- /dev/null +++ b/guide/src/reference/index.md @@ -0,0 +1,10 @@ +# Reference + +This section contains reference material for using `wasm-bindgen`. It is not +intended to be read start to finish. Instead, it aims to quickly answer +questions like: + +* Is type X supported as a parameter in a Rust function exported to JavaScript? + +* What was that CLI flag to disable ECMAScript modules output, and instead + attach the JavaScript bindings directly to `window`? diff --git a/guide/src/no-esm.md b/guide/src/reference/no-esm.md similarity index 100% rename from guide/src/no-esm.md rename to guide/src/reference/no-esm.md diff --git a/guide/src/passing-data.md b/guide/src/reference/passing-data.md similarity index 100% rename from guide/src/passing-data.md rename to guide/src/reference/passing-data.md diff --git a/guide/src/reference.md b/guide/src/reference/reference.md similarity index 100% rename from guide/src/reference.md rename to guide/src/reference/reference.md diff --git a/guide/src/basic-usage.md b/guide/src/whirlwind-tour/basic-usage.md similarity index 100% rename from guide/src/basic-usage.md rename to guide/src/whirlwind-tour/basic-usage.md diff --git a/guide/src/whirlwind-tour/introduction.md b/guide/src/whirlwind-tour/introduction.md new file mode 100644 index 00000000..10ac8a7c --- /dev/null +++ b/guide/src/whirlwind-tour/introduction.md @@ -0,0 +1,9 @@ +# A Whirlwind Tour of `wasm-bindgen` + +What follows is a whirlwind tour of `wasm-bindgen`. + +You will learn: + +* Setting up your development environment for `wasm-bindgen` +* Importing JavaScript functions and classes into Rust +* Exporting Rust structs and functions to JavaScript diff --git a/guide/src/what-else-can-we-do.md b/guide/src/whirlwind-tour/what-else-can-we-do.md similarity index 100% rename from guide/src/what-else-can-we-do.md rename to guide/src/whirlwind-tour/what-else-can-we-do.md diff --git a/guide/src/what-just-happened.md b/guide/src/whirlwind-tour/what-just-happened.md similarity index 100% rename from guide/src/what-just-happened.md rename to guide/src/whirlwind-tour/what-just-happened.md