cranelift/docs/SUMMARY.md

# Summary

- [Introduction](./introduction.md)
- [Tutorial](./tutorial.md)
  - [Creating `hello-world.wasm`](./tutorial-create-hello-world.md)
  - [Running `hello-world.wasm`](./tutorial-run-hello-world.md)
- [Examples](./examples.md)
  - [Markdown parser](./examples-markdown.md)
- [Using WebAssembly from your lanugage](./lang.md)
  - [Python](./lang-python.md)
  - [.NET](./lang-dotnet.md)
  - [Rust](./lang-rust.md)
  - [Bash](./lang-bash.md)
- [Using the `wasmtime` CLI](./cli.md)
  - [Installation](./cli-install.md)
  - [CLI Options](./cli-options.md)
  - [Cache Configuration](./cli-cache.md)
- [Writing WebAssembly](./wasm.md)
  - [Rust](./wasm-rust.md)
  - [C/C++](./wasm-c.md)
  - [WebAssembly Text Format (`*.wat`)](./wasm-wat.md)
  - [Example: Markdown Parser](./wasm-markdown.md)
- [Embedding Wasmtime](embed.md)
  - [Rust API](./embed-rust.md)
  - [C/C++ API](./embed-c.md)
- [Stability](stability.md)
  - [Release Process](./stability-release.md)
  - [Platform Support](./stability-platform-support.md)
- [Security](security.md)
  - [Disclosure Policy](./security-disclosure.md)
  - [Sandboxing](./security-sandboxing.md)
- [Contributing](contributing.md)
  - [Building](./contributing-building.md)
  - [Testing](./contributing-testing.md)
  - [Fuzzing](./contributing-fuzzing.md)
  - [CI](./contributing-ci.md)
  - [Release Process](./contributing-release-process.md)
  - [Governance](./contributing-governance.md)
  - [Code of Conduct](./contributing-coc.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook 5 years ago			`# Summary`

			`- [Introduction](./introduction.md)`
			`- [Tutorial](./tutorial.md)`
			- [Creating `hello-world.wasm`](./tutorial-create-hello-world.md)
			- [Running `hello-world.wasm`](./tutorial-run-hello-world.md)
			`- [Examples](./examples.md)`
			`- [Markdown parser](./examples-markdown.md)`
			`- [Using WebAssembly from your lanugage](./lang.md)`
			`- [Python](./lang-python.md)`
			`- [.NET](./lang-dotnet.md)`
			`- [Rust](./lang-rust.md)`
			`- [Bash](./lang-bash.md)`
			- [Using the `wasmtime` CLI](./cli.md)
			`- [Installation](./cli-install.md)`
			`- [CLI Options](./cli-options.md)`
			`- [Cache Configuration](./cli-cache.md)`
			`- [Writing WebAssembly](./wasm.md)`
			`- [Rust](./wasm-rust.md)`
			`- [C/C++](./wasm-c.md)`
Spice up the project README, fill out more docs (#1010) * Spice up the project README, fill out more docs This is an attempt to spruce up wasmtime's README.md file as well as fill out more of the missing documentation in the `docs/` folder. There's still a long way to go but I hoped here to mostly move around existing information and add new information. As always happy to have feedback! * Tweak CLI wording * Remove no-longer relevant clause * Update sandboxing docs * Handle comments 5 years ago			- [WebAssembly Text Format (`*.wat`)](./wasm-wat.md)
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook 5 years ago			`- [Example: Markdown Parser](./wasm-markdown.md)`
			`- [Embedding Wasmtime](embed.md)`
			`- [Rust API](./embed-rust.md)`
			`- [C/C++ API](./embed-c.md)`
			`- [Stability](stability.md)`
			`- [Release Process](./stability-release.md)`
			`- [Platform Support](./stability-platform-support.md)`
			`- [Security](security.md)`
			`- [Disclosure Policy](./security-disclosure.md)`
			`- [Sandboxing](./security-sandboxing.md)`
			`- [Contributing](contributing.md)`
			`- [Building](./contributing-building.md)`
docs: Add a section about how to test Wasmtime 5 years ago			`- [Testing](./contributing-testing.md)`
docs: Add a section about how to fuzz Wasmtime 5 years ago			`- [Fuzzing](./contributing-fuzzing.md)`
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook 5 years ago			`- [CI](./contributing-ci.md)`
Document and codify the release process The `wasmtime` release procees seems like it's been a bit ad-hoc up to this point, so I figured it'd be good to try to document what we do today and codify what should be done as well as a form of release checklist. I've noticed that we have a number of releases (like v0.11.0) but the `Cargo.toml` files in the repository don't reflect the current version of `wasmtime`. Additionally I've noticed that the [most recent release] ended up having failed tests because `Cargo.toml` was modified but `Cargo.lock` wasn't updated. I'm hoping that by having a checklist we can avoid these sorts of accidental issues in the future! [release]: https://github.com/bytecodealliance/wasmtime/runs/434690272 5 years ago			`- [Release Process](./contributing-release-process.md)`
Add book documentation skeleton and auto-publish from CI (#435) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook 5 years ago			`- [Governance](./contributing-governance.md)`
			`- [Code of Conduct](./contributing-coc.md)`