[Feat] - Migration of Docs from Old Site (#126)

* Migration of Books to Docs - v1

Signed-off-by: Adithya Krishna <[email protected]>

* Added zh Files

Signed-off-by: Adithya Krishna <[email protected]>

* Reverted Previous Change

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Spacing Issues

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed MD Syntax Error

Signed-off-by: Adithya Krishna <[email protected]>

* Fix Admonitions

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Prettier Issues

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Link

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links in Zh Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links in Zh Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links in ZhTW Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Added JS SDK

Signed-off-by: Adithya Krishna <[email protected]>

* Updated AOT Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Updated Installer Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Updated Yomo

Signed-off-by: Adithya Krishna <[email protected]>

* Updated CLI

Signed-off-by: Adithya Krishna <[email protected]>

* Updated Proposals

Signed-off-by: Adithya Krishna <[email protected]>

* Added C++ SDK

Signed-off-by: Adithya Krishna <[email protected]>

* Made Other Changes

Signed-off-by: Adithya Krishna <[email protected]>

* Prettier Format

Signed-off-by: Adithya Krishna <[email protected]>

* Updated K8s ContainerD Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Added Changes WRT #2535

Signed-off-by: Adithya Krishna <[email protected]>

* Added Changes to Wasi_Logging and Build from Src

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Lint Issues

Signed-off-by: Adithya Krishna <[email protected]>

* Updated CLI, WasiLogging, Install Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Updated NodeJS SDK Docs

Signed-off-by: Adithya Krishna <[email protected]>

* Prettier Format

Signed-off-by: Adithya Krishna <[email protected]>

* Updated AOT Doc

Signed-off-by: Adithya Krishna <[email protected]>

* Prettier Fix

Signed-off-by: Adithya Krishna <[email protected]>

* Made Requested Changes

Signed-off-by: Adithya Krishna <[email protected]>

* Made Requested Changes - v2

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Broken Links - v2

Signed-off-by: Adithya Krishna <[email protected]>

* Fixed Lint Issues

Signed-off-by: Adithya Krishna <[email protected]>

---------

Signed-off-by: Adithya Krishna <[email protected]>

Author: Adithya Krishna

docs/contribute/installer.md

@@ -2,11 +2,11 @@
 sidebar_position: 7
 ---
 
-# Installer System explanation
+# Installer Guide
 
 ## Overview
 
-WasmEdge installer is designed for installing the Core Tools (`wasmedge`, `wasmedgec`), the Libraries (`libwasmedge`), the Extensions(`wasmedge-tensorflow`), and the Plugins(`wasi-nn`, `wasi-crytpo`).
+WasmEdge installer is designed for installing the Core Tools (`wasmedge`, `wasmedge compile`), the Libraries (`libwasmedge`), the Extensions(`wasmedge-tensorflow`), and the Plugins(`wasi-nn`, `wasi-crytpo`).
 
 ## Dependencies
 

docs/contribute/plugin/develop_plugin_rustsdk.md

@@ -0,0 +1,49 @@
+# Develop WasmEdge Plug-in in Rust SDK with witc
+
+Once you complete C++ plugin code, you can use witc[^1] to generate Rust Plugin SDK
+
+## Example wasmedge_opencvmini
+
+Consider you get a file `wasmedge_opencvmini.wit` with below content
+
+```wit
+imdecode: func(buf: list<u8>) -> u32
+imshow: func(window-name: string, mat-key: u32) -> unit
+waitkey: func(delay: u32) -> unit
+```
+
+Using witc can generate Rust plugin code for it
+
+```shell
+witc plugin wasmedge_opencvmini.wit
+```
+
+Now, you will create a SDK crate by
+
+```shell
+cargo new --lib opencvmini-sdk && cd opencvmini-sdk
+```
+
+witc put rust code to stdout, therefore, you might like to create a new module file for generated code
+
+```shell
+witc plugin wasmedge_opencvmini.wit > src/generated.rs
+```
+
+Finally, you write down `mod generated` in `src/lib.rs` to access the code, and write some wrappers
+
+```rust
+mod generated;
+
+pub fn imdecode(buf: &[u8]) -> u32 {
+    unsafe { generated::imdecode(buf.as_ptr(), buf.len()) }
+}
+pub fn imshow(window_name: &str, mat_key: u32) -> () {
+    unsafe { generated::imshow(window_name.as_ptr(), window_name.len(), mat_key) }
+}
+pub fn waitkey(delay: u32) -> () {
+    unsafe { generated::waitkey(delay) }
+}
+```
+
+[^1]: <https://github.com/second-state/witc>

docs/contribute/source/build_from_src.md

@@ -29,8 +29,15 @@ WasmEdge provides various tools for enabling different runtime environments for
    - `wasmedge` executes a `WASM` file in the interpreter mode or a compiled `WASM` file in the ahead-of-time compilation mode.
    - To disable building all tools, you can set the CMake option `WASMEDGE_BUILD_TOOLS` to `OFF`.
 2. `wasmedgec` is the ahead-of-time `WASM` compiler.
+
    - `wasmedgec` compiles a general `WASM` file into a compiled `WASM` file.
    - To disable building the ahead-of-time compiler only, you can set the CMake option `WASMEDGE_BUILD_AOT_RUNTIME` to `OFF`.
+
+   <!-- prettier-ignore -->
+   :::note 
+   The usage of `wasmedgec` is equal to `wasmedge compile`. We decide to deprecate `wasmedgec` in the future.
+   :::
+
 3. `libwasmedge.so` is the WasmEdge C API shared library. (`libwasmedge.dylib` on MacOS and `wasmedge.dll` on Windows)
    - `libwasmedge.so`, `libwasmedge.dylib`, or `wasmedge.dll` provides the C API for the ahead-of-time compiler and the WASM runtime.
    - The APIs related to the ahead-of-time compiler will always fail if the CMake option `WASMEDGE_BUILD_AOT_RUNTIME` is set as `OFF`.
@@ -89,6 +96,7 @@ Developers can follow the steps to build WasmEdge with plug-ins from source.
 - [WasmEdge-Image](../source/plugin/image.md)
 - [WasmEdge-TensorFlow](../source/plugin/tensorflow.md)
 - [WasmEdge-TensorFlowLite](../source/plugin/tensorflowlite.md)
+- [WASI-Logging](../source/plugin/wasi_logging.md)
 
 ## Run Tests
 

docs/contribute/source/os/riscv64.md

@@ -64,12 +64,12 @@ ubuntu@riscv-lab:/labs/riscv-lab/WasmEdge/examples/wasm$ wasmedge --reactor add.
 4
 ```
 
-### Execute the wasmedgec tool
+### Execute wasmedge compile
 
-To improve the performance, the `wasmedgec` can compile WebAssembly into native machine code. After compiling with the `wasmedgec` AOT compiler, the wasmedge tool can execute the WASM in AOT mode which is much faster.
+To improve the performance, the `wasmedge compile` can compile WebAssembly into native machine code. After compiling with the `wasmedge compile` AOT compiler, the wasmedge tool can execute the WASM in AOT mode which is much faster.
 
 ```bash
-ubuntu@riscv-lab:/labs/riscv-lab/WasmEdge/examples/wasm$ wasmedgec fibonacci.wasm fibonacci_aot.wasm
+ubuntu@riscv-lab:/labs/riscv-lab/WasmEdge/examples/wasm$ wasmedge compile fibonacci.wasm fibonacci_aot.wasm
 [2023-02-01 22:39:15.807] [info] compile start
 [2023-02-01 22:39:15.857] [info] verify start
 [2023-02-01 22:39:15.866] [info] optimize start

docs/contribute/source/plugin/wasi_logging.md

@@ -0,0 +1,25 @@
+---
+sidebar_position: 1
+---
+
+# Build WasmEdge With WASI-Logging Plug-in
+
+## Prerequisites
+
+The prerequisite of the Wasi-Logging plug-in is the same as the WasmEdge building environment on the [Linux](../os/linux.md) and [MacOS](../os/macos.md) platforms.
+
+## Build WasmEdge with WASI-Logging Plug-in
+
+To enable the WASI-Logging Plug-in, developers need to build the WasmEdge from source with the cmake option `-DWASMEDGE_PLUGIN_WASI_LOGGING=ON`.
+
+```bash
+cd <path/to/your/wasmedge/source/folder>
+mkdir -p build && cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DWASMEDGE_PLUGIN_WASI_LOGGING=ON .. && make -j
+# For the WASI-Logging plug-in, you should install this project.
+cmake --install .
+```
+
+> If the built `wasmedge` CLI tool cannot find the WASI-Logging plug-in, you can set the `WASMEDGE_PLUGIN_PATH` environment variable to the plug-in installation path (`/usr/local/lib/wasmedge`, or the built plug-in path `build/plugins/wasi_logging`) to try to fix this issue. You should find `libwasmedgePluginWasiLogging.so` in your `WASMEDGE_PLUGIN_PATH`
+
+Then you will have an executable `wasmedge` runtime under `/usr/local/bin` and the WASI-Logging plug-in under `/usr/local/lib/wasmedge/libwasmedgePluginWasiLogging.so` after installation.

docs/develop/build-and-run/aot.md

@@ -4,68 +4,70 @@ sidebar_position: 3
 
 # The AoT Compiler
 
-One of the most important features of WasmEdge is the AoT compiler. The `wasmedgec` tool can compile any wasm file into native machine code (i.e., the AOT compiler). For the pure WebAssembly, the `wasmedge` tool will execute the WASM in interpreter mode. After compiling with the `wasmedgec` AOT compiler, the `wasmedge` tool can execute the WASM in AOT mode which is much faster.
+After [installation](../build-and-run/install.md), users can execute the `wasmedge compile` command.
 
-Use the `wasmedgec -v` or `wasmedgec --version` command to check the version of `wasmedgec` installed.
+The usage of the `wasmedge compile` command will be:
 
 ```bash
-$ wasmedgec -v
-wasmedge version {{ wasmedge_version }}
-```
-
-Use `wasmedgec -h` or `wasmedgec --help` to show the help message.
-
-```bash
-$ wasmedge -h
+$ wasmedge compile -h
 USAGE
-   wasmedgec [OPTIONS] [--] WASM WASM_SO
+   wasmedge compile [OPTIONS] [--] WASM WASM_SO
 
 ...
 ```
 
-## Output Format: Universal WASM
+The `wasmedge compile` command can compile WebAssembly into native machine code (i.e., the AOT compiler). For the pure WebAssembly, the `wasmedge` tool will execute the WASM in interpreter mode. After compiling with the `wasmedge compile` AOT compiler, the `wasmedge` tool can execute the WASM in AOT mode which is much faster.
 
-By default, the `wasmedgec` AOT compiler tool could wrap the AOT-compiled native binary into a custom section in the origin WASM file. We call this the universal WASM binary format.
+## Options
 
-This AOT-compiled WASM file is compatible with any WebAssembly runtime. However, when this WASM file is executed by the WasmEdge runtime, WasmEdge will extract the native binary from the custom section and execute it in AOT mode.
+The options of the `wasmedge compile` command are as follows.
 
-<!-- prettier-ignore -->
-:::note
-On MacOS platforms, the universal WASM format will `bus error` in execution. It's because the `wasmedgec` tool optimizes the WASM in `O2` level by default. We are trying to fix this issue. For working around, please use the shared library output format instead.
-:::
-
-```bash
-wasmedgec app.wasm app_aot.wasm
-wasmedge app_aot.wasm
-```
-
-## Output Format: Shared Library
-
-Users can assign the shared library extension for the output files (`.so` on Linux, `.dylib` on MacOS, and `.dll` on Windows) to generate the shared library output format output.
-
-This AOT-compiled WASM file is only for WasmEdge use, and cannot be used by other WebAssembly runtimes.
-
-```bash
-wasmedgec app.wasm app_aot.so
-wasmedge app_aot.so
-```
-
-## Example for the AoT compiler
+1. `-h|--help`: Show the help messages. Will ignore other arguments below.
+2. (Optional) `--dump`: Dump the LLVM IR to `wasm.ll` and `wasm-opt.ll`.
+3. (Optional) `--interruptible`: Generate the binary which supports interruptible execution.
+   - By default, the AOT-compiled WASM not supports [interruptions in asynchronous executions](../../embed/c/reference/0.12.x#async).
+4. (Optional) Statistics information:
+   - By default, the AOT-compiled WASM not supports all statistics even if the options are turned on when running the `wasmedge` tool.
+   - Use `--enable-time-measuring` to generate code for enabling the statistics of time measuring in execution.
+   - Use `--enable-gas-measuring` to generate code for enabling the statistics of gas measuring in execution.
+   - Use `--enable-instruction-count` to generate code for enabling the statistics of counting WebAssembly instructions.
+   - Or use `--enable-all-statistics` to generate code for enabling all of the statistics.
+5. (Optional) `--generic-binary`: Generate the generic binary of the current host CPU architecture.
+6. (Optional) WebAssembly proposals:
+   - Use `--disable-import-export-mut-globals` to disable the [Import/Export of Mutable Globals](https://github.com/WebAssembly/mutable-global) proposal (Default `ON`).
+   - Use `--disable-non-trap-float-to-int` to disable the [Non-Trapping Float-to-Int Conversions](https://github.com/WebAssembly/nontrapping-float-to-int-conversions) proposal (Default `ON`).
+   - Use `--disable-sign-extension-operators` to disable the [Sign-Extension Operators](https://github.com/WebAssembly/sign-extension-ops) proposal (Default `ON`).
+   - Use `--disable-multi-value` to disable the [Multi-value](https://github.com/WebAssembly/multi-value) proposal (Default `ON`).
+   - Use `--disable-bulk-memory` to disable the [Bulk Memory Operations](https://github.com/WebAssembly/bulk-memory-operations) proposal (Default `ON`).
+   - Use `--disable-reference-types` to disable the [Reference Types](https://github.com/WebAssembly/reference-types) proposal (Default `ON`).
+   - Use `--disable-simd` to disable the [Fixed-width SIMD](https://github.com/webassembly/simd) proposal (Default `ON`).
+   - Use `--enable-multi-memory` to enable the [Multiple Memories](https://github.com/WebAssembly/multi-memory) proposal (Default `OFF`).
+   - Use `--enable-tail-call` to enable the [Tail call](https://github.com/WebAssembly/tail-call) proposal (Default `OFF`).
+   - Use `--enable-extended-const` to enable the [Extended Constant Expressions](https://github.com/WebAssembly/extended-const) proposal (Default `OFF`).
+   - Use `--enable-threads` to enable the [Threads](https://github.com/webassembly/threads) proposal (Default `OFF`).
+   - Use `--enable-all` to enable ALL proposals above.
+7. (Optional) `--optimize`: Select the LLVM optimization level.
+   - Use `--optimize LEVEL` to set the optimization level. The `LEVEL` should be one of `0`, `1`, `2`, `3`, `s`, or `z`.
+   - The default value will be `2`, which means `O2`.
+8. Input WASM file (`/path/to/wasm/file`).
+9. Output path (`/path/to/output/file`).
+   - By default, the `wasmedge compile` command will output the [universal WASM format](#output-format-universal-wasm).
+   - If the specific file extension (`.so` on Linux, `.dylib` on MacOS, and `.dll` on Windows) is assigned in the output path, the `wasmedge compile` command will output the [shared library format](#output-format-shared-library).
 
-Use `wasmedgec XYZ.wasm XYZ.wasm` to compile WebAssembly into native machine code.
+## Example
 
 Take the [fibonacci.wasm](https://github.com/WasmEdge/WasmEdge/raw/master/examples/wasm/fibonacci.wasm) for example. It exported a `fib()` function which takes a single `i32` integer as the input parameter.
 
 You can run:
 
 ```bash
-wasmedgec fibonacci.wasm fibonacci_aot.wasm
+wasmedge compile fibonacci.wasm fibonacci_aot.wasm
 ```
 
 or:
 
 ```bash
-wasmedgec fibonacci.wasm fibonacci_aot.so # On Linux.
+wasmedge compile fibonacci.wasm fibonacci_aot.so # On Linux.
 ```
 
 The output will be:
@@ -79,7 +81,7 @@ The output will be:
 [2022-09-09 14:22:10.600] [info] compile done
 ```
 
-Next, you can execute the output file with `wasmedge` and measure the execution time:
+Then you can execute the output file with `wasmedge` and measure the execution time:
 
 ```bash
 time wasmedge --reactor fibonacci_aot.wasm fib 30
@@ -111,39 +113,29 @@ user    0m0.427s
 sys     0m0.012s
 ```
 
-## All options for the AoT compiler
+## Output Format: Universal WASM
 
-The options of the `wasmedgec` CLI tool are as follows.
+By default, the `wasmedge compile` AOT compiler tool could wrap the AOT-compiled native binary into a custom section in the origin WASM file. We call this the universal WASM binary format.
 
-1. `-v|--version`: Show the version information. Will ignore other arguments below.
-2. `-h|--help`: Show the help messages. Will ignore other arguments below.
-3. (Optional) `--dump`: Dump the LLVM IR to `wasm.ll` and `wasm-opt.ll`.
-4. (Optional) `--interruptible`: Generate the binary which supports interruptible execution.
-   - By default, the AOT-compiled WASM not supports [interruptions in asynchronous executions].
-5. (Optional) Statistics information:
-   - By default, the AOT-compiled WASM not supports all statistics even if the options are turned on when running the `wasmedge` tool.
-   - Use `--enable-time-measuring` to generate code for enabling the statistics of time measuring in execution.
-   - Use `--enable-gas-measuring` to generate code for enabling the statistics of gas measuring in execution.
-   - Use `--enable-instruction-count` to generate code for enabling the statistics of counting WebAssembly instructions.
-   - Or use `--enable-all-statistics` to generate code for enabling all of the statistics.
-6. (Optional) `--generic-binary`: Generate the generic binary of the current host CPU architecture.
-7. (Optional) WebAssembly proposals:
-   - Use `--disable-import-export-mut-globals` to disable the [Import/Export of Mutable Globals](https://github.com/WebAssembly/mutable-global) proposal (Default `ON`).
-   - Use `--disable-non-trap-float-to-int` to disable the [Non-Trapping Float-to-Int Conversions](https://github.com/WebAssembly/nontrapping-float-to-int-conversions) proposal (Default `ON`).
-   - Use `--disable-sign-extension-operators` to disable the [Sign-Extension Operators](https://github.com/WebAssembly/sign-extension-ops) proposal (Default `ON`).
-   - Use `--disable-multi-value` to disable the [Multi-value](https://github.com/WebAssembly/multi-value) proposal (Default `ON`).
-   - Use `--disable-bulk-memory` to disable the [Bulk Memory Operations](https://github.com/WebAssembly/bulk-memory-operations) proposal (Default `ON`).
-   - Use `--disable-reference-types` to disable the [Reference Types](https://github.com/WebAssembly/reference-types) proposal (Default `ON`).
-   - Use `--disable-simd` to disable the [Fixed-width SIMD](https://github.com/webassembly/simd) proposal (Default `ON`).
-   - Use `--enable-multi-memory` to enable the [Multiple Memories](https://github.com/WebAssembly/multi-memory) proposal (Default `OFF`).
-   - Use `--enable-tail-call` to enable the [Tail call](https://github.com/WebAssembly/tail-call) proposal (Default `OFF`).
-   - Use `--enable-extended-const` to enable the [Extended Constant Expressions](https://github.com/WebAssembly/extended-const) proposal (Default `OFF`).
-   - Use `--enable-threads` to enable the [Threads](https://github.com/webassembly/threads) proposal (Default `OFF`).
-   - Use `--enable-all` to enable ALL proposals above.
-8. (Optional) `--optimize`: Select the LLVM optimization level.
-   - Use `--optimize LEVEL` to set the optimization level. The `LEVEL` should be one of `0`, `1`, `2`, `3`, `s`, or `z`.
-   - The default value will be `2`, which means `O2`.
-9. Input WASM file (`/path/to/wasm/file`).
-10. Output path (`/path/to/output/file`).
-    - By default, the `wasmedgec` tool will output the universal Wasm format, which embeds a native code section into the Wasm file.
-    - If the specific file extension (`.so` on Linux, `.dylib` on MacOS, and `.dll` on Windows) is assigned in the output path, the `wasmedgec` tool will output the [shared library format](https://tldp.org/HOWTO/Program-Library-HOWTO/shared-libraries.html).
+This AOT-compiled WASM file is compatible with any WebAssembly runtime. However, when this WASM file is executed by the WasmEdge runtime, WasmEdge will extract the native binary from the custom section and execute it in AOT mode.
+
+<!-- prettier-ignore -->
+:::note
+On MacOS platforms, the universal WASM format will `bus error` in execution. It's because the `wasmedge compile` tool optimizes the WASM in `O2` level by default. We are trying to fix this issue. For working around, please use the shared library output format instead.
+:::
+
+```bash
+wasmedge compile app.wasm app_aot.wasm
+wasmedge app_aot.wasm
+```
+
+## Output Format: Shared Library
+
+Users can assign the shared library extension for the output files (`.so` on Linux, `.dylib` on MacOS, and `.dll` on Windows) to generate the shared library output format output.
+
+This AOT-compiled WASM file is only for WasmEdge use, and cannot be used by other WebAssembly runtimes.
+
+```bash
+wasmedge compile app.wasm app_aot.so
+wasmedge app_aot.so
+```