Merge #2041

2041: doc(example) Add white background and reduce diagram sizes r=Hywan a=Hywan # Description This PR adds a white background to the diagrams instead of having a transparent background. It fixes #2029. The diagrams have also been compressed to reduce their file size (-32.3Kb, -45.8Kb, -19.5Kb saved). Edit: This PR also fixes missing links and fix issues in the `examples/README.md` file. # Review - [ ] Add a short description of the the change to the CHANGELOG.md file Co-authored-by: Ivan Enderlin <[email protected]>
wasmerio · Jan 22, 2021 · 4378b22 · 4378b22
2 parents c48fdde + a935f11
commit 4378b22
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
 - [#2026](https://github.com/wasmerio/wasmer/pull/2010) Expose trap code of a `RuntimeError`, if it's a `Trap`.
 
 ### Changed
+- [#2041](https://github.com/wasmerio/wasmer/pull/2041) Documentation diagrams now have a solid white background rather than a transparent background.
 
 ### Fixed
 

diff --git a/assets/diagrams/Diagram_module_compilation.png b/assets/diagrams/Diagram_module_compilation.png
diff --git a/assets/diagrams/Diagram_module_instantiation.png b/assets/diagrams/Diagram_module_instantiation.png
diff --git a/assets/diagrams/Diagram_module_serialization.png b/assets/diagrams/Diagram_module_serialization.png
diff --git a/examples/README.md b/examples/README.md
@@ -70,13 +70,13 @@ example.
 3. [**Handling errors**][errors], explains the basics of interacting with
    Wasm module memory.
 
-   _Keywords_: memory, module.
+   _Keywords_: instance, error.
 
    <details>
     <summary><em>Execute the example</em></summary>
 
     ```shell
-    $ cargo run --example memory --release --features "cranelift"
+    $ cargo run --example errors --release --features "cranelift"
     ```
 
    </details>
@@ -204,7 +204,7 @@ example.
 
 ### Tunables
 
-1. **Limit memory**, explains how to use Tunables to limit the
+1. [**Limit memory**][tunables-limit-memory], explains how to use Tunables to limit the
    size of an exported Wasm memory
 
    _Keywords_: basic, tunables, memory
@@ -360,6 +360,7 @@ example.
 
    </details>
 
+[hello-world]: ./hello_world.rs
 [engine-jit]: ./engine_jit.rs
 [engine-native]: ./engine_native.rs
 [engine-headless]: ./engine_headless.rs
@@ -377,6 +378,8 @@ example.
 [wasi-pipes]: ./wasi_pipes.rs
 [table]: ./table.rs
 [memory]: ./memory.rs
+[errors]: ./errors.rs
+[tunables-limit-memory]: ./tunables_limit_memory.rs
 [`wasmer-compiler-singlepass`]: https://github.com/wasmerio/wasmer/tree/master/lib/compiler-singlepass
 [`wasmer-compiler-cranelift`]: https://github.com/wasmerio/wasmer/tree/master/lib/compiler-cranelift
 [`wasmer-compiler-llvm`]: https://github.com/wasmerio/wasmer/tree/master/lib/compiler-llvm