Refactor the API ref docs. (#121)

0. Fix the duplicated lint and build check.
1. Rename the file name.
2. Use the `latest.md` for the latest API docs.
3. Correct the title.
4. Use the WASMEDGE_VERSION variable.

Signed-off-by: YiYing He <[email protected]>

Author: q82419

.env

@@ -1 +1 @@
-WASMEDGE_VERSION='0.11.2'
+WASMEDGE_VERSION='0.13.0'

.github/workflows/build-test.yml

@@ -2,6 +2,8 @@ name: Build Check
 on:
   workflow_dispatch:
   push:
+    branches:
+      - main
     paths-ignore:
       - 'README.md'
       - 'LICENSE'
@@ -12,6 +14,8 @@ on:
       - '.env'
       - '.gitignore'
   pull_request:
+    branches:
+      - main
     paths-ignore:
       - 'README.md'
       - 'LICENSE'

.github/workflows/lint.yml

@@ -3,6 +3,8 @@ name: Lint
 on:
   workflow_dispatch:
   push:
+    branches:
+      - main
   pull_request:
     branches:
       - main

README.md

@@ -1,31 +1,31 @@
-![WasmEdge Logo](https://github.com/WasmEdge/.github/raw/main/profile/wasmedge-runtime-logo.png)
-
 # WasmEdge Docs
 
-This repo contains technical documentation for the [WasmEdge Runtime](https://github.com/WasmEdge/WasmEdge) project. The documentation website built from this repo is published https://wasmedge.org/docs/, check it out!
+![WasmEdge Logo](https://github.com/WasmEdge/.github/raw/main/profile/wasmedge-runtime-logo.png)
+
+This repo contains technical documentation for the [WasmEdge Runtime](https://github.com/WasmEdge/WasmEdge) project. The documentation website built from this repo is published <https://wasmedge.org/docs/>, check it out!
 
-# Setting up the Docs Locally
+## Setting up the Docs Locally
 
 To set up the WasmEdge Docs locally, you will need to follow these general steps:
 
 1. **Clone the project:** Go to the GitHub repository page of the WasmEdge Docs project and click on the "Code" button to get the URL of the repository. Then, open a terminal or command prompt and type the following command:
 
-```bash
-git clone https://github.com/WasmEdge/docs.git
-```
+   ```bash
+   git clone https://github.com/WasmEdge/docs.git
+   ```
 
 2. **Install dependencies:** Navigate to the project directory in the terminal and run the following command to install the necessary dependencies:
 
-```bash
-npm install
-```
+   ```bash
+   npm install
+   ```
 
 3. **Start the development server:** Once the dependencies are installed, you can start the development server by running the following command:
 
-```bash
-npm start
-```
+   ```bash
+   npm start
+   ```
 
-This should start the development server on port 3000. You can access the running application by opening a web browser and navigating to http://localhost:3000/docs/.
+This should start the development server on port 3000. You can access the running application by opening a web browser and navigating to <http://localhost:3000/docs/>.
 
 That's it! You should now have a local instance of the WasmEdge Docs running on your machine.

docs/contribute/installer.md

@@ -63,7 +63,7 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
 - Short Option: `-v VERSION`
 - Full Option: `--version VERSION`
 - Description: Install the given VERSION of WasmEdge
-- Available Value: VERSION `0.11.2` or other valid release versions.
+- Available Value: VERSION `{{ wasmedge_version }}` or other valid release versions.
 - Note - In the case of supplied an invalid or nonexistent version, the installer exists with an error.
 
 ### Installation path
@@ -123,7 +123,7 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
 
 - Note - Currently `--plugins` is an experimental option.
 
-- Full Option: `--plugins wasi_crypto:0.11.0`
+- Full Option: `--plugins wasi_crypto:0.12.0`
 
 - Note - The format for this argument is `<plugin_name>:<version_number>`. `<version_number>` is not compulsory. For example `--plugins wasi_crypto` is a valid option.
 - Note - `<plugin_name>` is cases sensitive. Allowed values are stated [here](https://wasmedge.org/docs/contribute/plugin/intro) in the `Rust Crate` column. The logic is that the release name should be the same.

docs/contribute/plugin/develop_plugin_c.md

@@ -18,7 +18,7 @@ Assume that the plug-in example is in the file `testplugin.c`.
 
 The goal of the plug-in is to provide the host functions which can be imported when instantiating WASM.
 
-Therefore, developers can implement their plug-in host functions first, as the same as the [host functions in WasmEdge C API](/embed/c/reference/0.12.0.md#host-functions).
+Therefore, developers can implement their plug-in host functions first, as the same as the [host functions in WasmEdge C API](/embed/c/reference/latest.md#host-functions).
 
 > For the more details about the [external data](/embed/c/host_function.md#host-data) and [calling frame context](/embed/c/host_function.md#calling-frame-context), please refer to the host function guide.
 

docs/contribute/source/os/android/cli.md

@@ -6,6 +6,11 @@ sidebar_position: 2
 
 In this section, we will show you how to use WasmEdge CLI tools on Android devices. We will showcase a full WasmEdge demo to perform image classification (Tensorflow-based AI inference) on an Android device.
 
+<!-- prettier-ignore -->
+:::note
+The `WasmEdge-tensorflow-tools` has been deprecated after the 0.12.1 version. We'll update to use the WasmEdge plug-in in the future.
+:::
+
 ## Install Android version of WasmEdge-TensorFlow-Tools
 
 First, install WasmEdge-TensorFlow-Tools pre-release on your Android device. It works with the Android version of TensorFlow-Lite dynamic shared library.
@@ -36,8 +41,8 @@ sirius:/ $
 Use the following commands on your Ubuntu dev machine to download the WasmEdge-TensorFlow-Tools pre-release packages.
 
 ```bash
-$ wget https://github.com/second-state/WasmEdge-tensorflow-tools/releases/download/{{ wasmedge_version }}/WasmEdge-tensorflow-tools-{{ wasmedge_version }}-android_aarch64.tar.gz
-$ mkdir WasmEdge-tensorflow-tools && tar zxvf WasmEdge-tensorflow-tools-{{ wasmedge_version }}-android_aarch64.tar.gz -C WasmEdge-tensorflow-tools
+$ wget https://github.com/second-state/WasmEdge-tensorflow-tools/releases/download/0.12.1/WasmEdge-tensorflow-tools-0.12.1-android_aarch64.tar.gz
+$ mkdir WasmEdge-tensorflow-tools && tar zxvf WasmEdge-tensorflow-tools-0.12.1-android_aarch64.tar.gz -C WasmEdge-tensorflow-tools
 show-tflite-tensor
 wasmedge-tensorflow-lite
 ```
@@ -47,8 +52,8 @@ wasmedge-tensorflow-lite
 We provide an Android compatible version of TensorFlow-Lite dynamic shared library in the WasmEdge-Tensorflow-deps package. Download the package to your Ubuntu dev machine as follows.
 
 ```bash
-$ wget https://github.com/second-state/WasmEdge-tensorflow-deps/releases/download/{{ wasmedge_version }}/WasmEdge-tensorflow-deps-TFLite-{{ wasmedge_version }}-android_aarch64.tar.gz
-$ tar zxvf WasmEdge-tensorflow-deps-TFLite-{{ wasmedge_version }}-android_aarch64.tar.gz -C WasmEdge-tensorflow-tools
+$ wget https://github.com/second-state/WasmEdge-tensorflow-deps/releases/download/0.12.1/WasmEdge-tensorflow-deps-TFLite-0.12.1-android_aarch64.tar.gz
+$ tar zxvf WasmEdge-tensorflow-deps-TFLite-0.12.1-android_aarch64.tar.gz -C WasmEdge-tensorflow-tools
 libtensorflowlite_c.so
 ```
 

docs/contribute/source/os/android/ndk.md

@@ -6,6 +6,11 @@ sidebar_position: 3
 
 In this section, we will demonstrate how to build an Android native application using C and the Android SDK. The native application uses the WasmEdge C SDK to embed the WasmEdge Runtime, and call WASM functions through WasmEdge.
 
+<!-- prettier-ignore -->
+:::note
+The `WasmEdge-Image`, `WasmEdge-Tensorflow`, and `WasmEdge-tensorflow-tools` have been deprecated after the 0.12.1 version. We'll update to use the WasmEdge plug-in in the future.
+:::
+
 ## Prerequisite
 
 ### Android
@@ -92,22 +97,22 @@ int main(int argc, char *argv[]) {
 Use the following commands to download WasmEdge for Android on your Ubuntu dev machine.
 
 ```bash
-wget https://github.com/WasmEdge/WasmEdge/releases/download/{{ wasmedge_version }}/WasmEdge-{{ wasmedge_version }}-android_aarch64.tar.gz
-wget https://github.com/second-state/WasmEdge-image/releases/download/{{ wasmedge_version }}/WasmEdge-image-{{ wasmedge_version }}-android_aarch64.tar.gz
-wget https://github.com/second-state/WasmEdge-tensorflow/releases/download/{{ wasmedge_version }}/WasmEdge-tensorflowlite-{{ wasmedge_version }}-android_aarch64.tar.gz
-wget https://github.com/second-state/WasmEdge-tensorflow-deps/releases/download/{{ wasmedge_version }}/WasmEdge-tensorflow-deps-TFLite-{{ wasmedge_version }}-android_aarch64.tar.gz
-tar -zxf WasmEdge-{{ wasmedge_version }}-android_aarch64.tar.gz
-tar -zxf WasmEdge-image-{{ wasmedge_version }}-android_aarch64.tar.gz -C WasmEdge-{{ wasmedge_version }}-Android/
-tar -zxf WasmEdge-tensorflowlite-{{ wasmedge_version }}-android_aarch64.tar.gz -C WasmEdge-{{ wasmedge_version }}-Android/
-tar -zxf WasmEdge-tensorflow-deps-TFLite-{{ wasmedge_version }}-android_aarch64.tar.gz -C WasmEdge-{{ wasmedge_version }}-Android/lib/
+wget https://github.com/WasmEdge/WasmEdge/releases/download/0.12.1/WasmEdge-0.12.1-android_aarch64.tar.gz
+wget https://github.com/second-state/WasmEdge-image/releases/download/0.12.1/WasmEdge-image-0.12.1-android_aarch64.tar.gz
+wget https://github.com/second-state/WasmEdge-tensorflow/releases/download/0.12.1/WasmEdge-tensorflowlite-0.12.1-android_aarch64.tar.gz
+wget https://github.com/second-state/WasmEdge-tensorflow-deps/releases/download/0.12.1/WasmEdge-tensorflow-deps-TFLite-0.12.1-android_aarch64.tar.gz
+tar -zxf WasmEdge-0.12.1-android_aarch64.tar.gz
+tar -zxf WasmEdge-image-0.12.1-android_aarch64.tar.gz -C WasmEdge-0.12.1-Android/
+tar -zxf WasmEdge-tensorflowlite-0.12.1-android_aarch64.tar.gz -C WasmEdge-0.12.1-Android/
+tar -zxf WasmEdge-tensorflow-deps-TFLite-0.12.1-android_aarch64.tar.gz -C WasmEdge-0.12.1-Android/lib/
 ```
 
 ### Compile
 
 The following command compiles the C program to `a.out` on your Ubunu dev machine.
 
 ```bash
-(/path/to/ndk)/toolchains/llvm/prebuilt/(HostPlatform)/bin/aarch64-linux-(AndroidApiVersion)-clang test.c -I./WasmEdge-{{ wasmedge_version }}-Android/include -L./WasmEdge-{{ wasmedge_version }}-Android/lib -lwasmedge-image_c -lwasmedge-tensorflowlite_c -ltensorflowlite_c -lwasmedge
+(/path/to/ndk)/toolchains/llvm/prebuilt/(HostPlatform)/bin/aarch64-linux-(AndroidApiVersion)-clang test.c -I./WasmEdge-0.12.1-Android/include -L./WasmEdge-0.12.1-Android/lib -lwasmedge-image_c -lwasmedge-tensorflowlite_c -ltensorflowlite_c -lwasmedge
 ```
 
 ## Run
@@ -121,7 +126,7 @@ adb push a.out /data/local/tmp
 adb push birds_v1.wasm /data/local/tmp
 adb push lite-model_aiy_vision_classifier_birds_V1_3.tflite /data/local/tmp
 adb push bird.jpg /data/local/tmp
-adb push ./WasmEdge-{{ wasmedge_version }}-Android/lib /data/local/tmp
+adb push ./WasmEdge-0.12.1-Android/lib /data/local/tmp
 ```
 
 ### Run the example

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

@@ -289,14 +289,19 @@ world
 
 Use `wasmedge-tensorflow-lite` ([link](https://github.com/WasmEdge/WasmEdge/tree/master/examples/js)):
 
+<!-- prettier-ignore -->
+:::note
+The `WasmEdge-tensorflow-tools` has been deprecated after the 0.12.1 version. We'll update to use the WasmEdge plug-in in the future.
+:::
+
 ```bash
-$ docker pull wasmedge/slim-tf:{{ wasmedge_version }}
+$ docker pull wasmedge/slim-tf:0.12.1
 $ wget https://raw.githubusercontent.com/second-state/wasmedge-quickjs/main/example_js/tensorflow_lite_demo/aiy_food_V1_labelmap.txt
 $ wget https://raw.githubusercontent.com/second-state/wasmedge-quickjs/main/example_js/tensorflow_lite_demo/food.jpg
 $ wget https://raw.githubusercontent.com/second-state/wasmedge-quickjs/main/example_js/tensorflow_lite_demo/lite-model_aiy_vision_classifier_food_V1_1.tflite
 $ wget https://raw.githubusercontent.com/second-state/wasmedge-quickjs/main/example_js/tensorflow_lite_demo/main.js
 
-$ docker run -it --rm -v $PWD:/app wasmedge/slim-tf:{{ wasmedge_version }} wasmedge-tensorflow-lite --dir .:. qjs_tf.wasm main.js
+$ docker run -it --rm -v $PWD:/app wasmedge/slim-tf:0.12.1 wasmedge-tensorflow-lite --dir .:. qjs_tf.wasm main.js
 label:
 Hot dog
 confidence:

docs/develop/rust/bindgen.md

@@ -4,7 +4,7 @@ sidebar_position: 10
 
 # Bindgen of Rust Functions
 
-If your Rust program has a `main()` function, you could compile it into WebAssembly, and run it using the `wasmedge` CLI tool as a standalone application. However, a far more common use case is to compile a Rust function into WebAssembly, and then call it from a host application. That is known as an embedded WASM function. The host application uses WasmEdge language SDKs (e.g., [Go](/category/go-sdk-for-embedding-wasm-functions), [Rust](/category/rust-sdk-for-embedding-wasm-functions), [C](/category/c-sdk-for-embedding-wasm-functions), Python (WIP) and Java (WIP)) to call those WASM functions compiled from Rust source code. In this chapter, we will cover a little about WasmEdge-bindgen and you can find more information [here](/category/passing-complex-data)
+If your Rust program has a `main()` function, you could compile it into WebAssembly, and run it using the `wasmedge` CLI tool as a standalone application. However, a far more common use case is to compile a Rust function into WebAssembly, and then call it from a host application. That is known as an embedded WASM function. The host application uses WasmEdge language SDKs (e.g., [Go](/category/go-sdk-for-embedding-wasmedge), [Rust](/category/rust-sdk-for-embedding-wasmedge), [C](/category/c-sdk-for-embedding-wasmedge), Python (WIP) and Java (WIP)) to call those WASM functions compiled from Rust source code. In this chapter, we will cover a little about WasmEdge-bindgen and you can find more information [here](/category/passing-complex-data)
 
 All the WasmEdge host language SDKs support simple function calls. However, the WASM spec only supports a few simple data types as call parameters and return values, such as `i32`, `i64`, `f32`, `f64`, and `v128`. The `wasmedge-bindgen` crate would transform parameters and return values of Rust functions into simple integer types when the Rust function is compiled into WASM. For example, a string is automatically converted into two integers, a memory address and a length, which can be handled by the standard WASM spec. It is very easy to do this in Rust source code. Just annotate your function with the `#[wasmedge-bindgen]` macro. You can compile the annotated Rust code using the standard Rust compiler toolchain (e.g., the latest `Cargo`).