Refactor the docs to separate the getting-started chapter. (#135)

1. Separate the getting-started chapter.
2. Fix the links to use the related path.
3. Fix the description for plug-ins.

Signed-off-by: YiYing He <yiying@secondstate.io>

Author: q82419

CONTRIBUTING.md

@@ -6,40 +6,36 @@ This project values community collaboration and welcomes contributions from all
 
 If you are ready to contribute, please search for open issues labeled "help-wanted" and choose one to work on. Feel free to join our Slack channel to participate in discussions or create a new issue if you have a suggestion or request. When submitting a pull request, please reference the corresponding open issue if one exists. To automatically close related issues in GitHub, include keywords in your pull request descriptions and commit messages.
 
-**Contents**
-
-- <a name="contributing-flow">Contribution Flow</a>
-  - <a href="#commit-signoff">Developer Certificate of Origin</a>
+- [Contribution Flow](#contribution-flow)
+  - [Developer Certificate of Origin](#signing-off-on-commits-developer-certificate-of-origin)
 - WasmEdge Contribution Flow
-  - <a href="#contributing-docs">WasmEdge Docs</a>
-  - <a href="https://wasmedge.org/docs/contribute/" target="_blank">WasmEdge Runtime</a>
-  - <a href="https://github.com/WasmEdge/WasmEdge/blob/master/SECURITY.md" target="_blank">Reporting a vulnerability</a>
+  - [WasmEdge Docs](#wasmedge-docs)
+  - [WasmEdge Runtime](https://wasmedge.org/docs/contribute/)
+  - [Reporting a vulnerability](https://github.com/WasmEdge/WasmEdge/blob/master/SECURITY.md)
 
-# <a name="contributing-flow">Contribution Flow</a>
+## Contribution Flow
 
 To contribute to WasmEdge Docs
 
-## <a name="commit-signoff">Signing-off on Commits (Developer Certificate of Origin)</a>
+### Signing-off on Commits (Developer Certificate of Origin)
 
 To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.
 
 See the [DCO](https://developercertificate.org) file for the full text of what you must agree to and how it works [here](https://github.com/probot/dco#how-it-works). To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages:
 
-```
+```text
 Signed-off-by: John Doe <john.doe@example.com>
 ```
 
 In most cases, you can add this signoff to your commit automatically with the `-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:
 
 ```bash
-$ git commit -s -m “my commit message w/signoff”
+git commit -s -m “my commit message w/signoff”
 ```
 
 To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`:
 
-_~/.gitconfig_
-
-```
+```text
 [alias]
   amend = commit -s --amend
   cm = commit -s -m
@@ -48,46 +44,46 @@ _~/.gitconfig_
 
 Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you:
 
-<a href="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" ><img src="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" width="50%"><a>
+![VSCode sign-off](https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png)
 
-## <a name="contributing-docs">WasmEdge Docs</a>
+### WasmEdge Docs
 
 If you want to contribute to the WasmEdge Docs, you can follow these steps:
 
 1. **Fork the project:** Click the "Fork" button on the top-right corner of the repository page to create a copy of the project in your GitHub account.
 
 2. **Clone the forked project:** Open a terminal or command prompt and type the following command:
 
-```bash
-git clone <forked-repository-url>
-```
+   ```bash
+   git clone <forked-repository-url>
+   ```
 
 3. **Create a new branch:** Navigate to the project directory and create a new branch to make your changes in:
 
-```bash
-git checkout -b my-new-branch
-```
+   ```bash
+   git checkout -b my-new-branch
+   ```
 
 4. **Make your changes:** Make any changes or additions to the documentation in the project directory.
 
 5. **Commit your changes:** Once you are satisfied with your changes, commit them with a descriptive commit message
 
-```bash
-git add .
-```
+   ```bash
+   git add .
+   ```
 
-```bash
-git commit -m " Message  Signed-off-by: Name <email@example.com> "
-                             OR
-                 git commit -s -m " Message "
-```
+   ```bash
+   git commit -m " Message  Signed-off-by: Name <email@example.com> "
+                               OR
+                   git commit -s -m " Message "
+   ```
 
 6. **Push your changes:** Push your changes to your forked repository:
 
-```bash
-git push origin my-new-branch
-```
+   ```bash
+   git push origin my-new-branch
+   ```
 
-7. **Create a pull request:** Go to the our repository page, https://github.com/WasmEdge/docs and click the "New pull request" button. Select your forked repository and the branch you created. Add a description of your changes and click "Create pull request".
+7. **Create a pull request:** Go to the our repository page, <https://github.com/WasmEdge/docs> and click the "New pull request" button. Select your forked repository and the branch you created. Add a description of your changes and click "Create pull request".
 
 That's it! Your changes will now be reviewed by the maintainers of the WasmEdge Docs project.

docs/contribute/contribute.md

@@ -12,7 +12,7 @@ Our development environment requires `libLLVM-12` and `>=GLIBCXX_3.4.26`.
 
 If you are using an operating system older than Ubuntu 20.04, please use our [special docker image] to build WasmEdge. If you are looking for the pre-built binaries for the older operating system, we also provide several pre-built binaries based on `manylinux2014` distribution.
 
-To build WasmEdge from the source, please refer to: [Build WasmEdge from source](../category/build-wasmedge-from-source).
+To build WasmEdge from the source, please refer to: [Build WasmEdge from source](/category/build-wasmedge-from-source).
 
 ## Contribution Workflow
 
@@ -37,7 +37,7 @@ The WasmEdge project adopts [DCO](https://www.secondstate.io/articles/dco/) to m
 
 ### Develop, Build and Test
 
-Write code on the new branch in your fork, and [build from source code](../category/build-wasmedge-from-source) with the option `-DWASMEDGE_BUILD_TESTS=ON`.
+Write code on the new branch in your fork, and [build from source code](/category/build-wasmedge-from-source) with the option `-DWASMEDGE_BUILD_TESTS=ON`.
 
 Then you can use these tests to verify the correctness of WasmEdge binaries.
 

docs/contribute/installer.md

@@ -126,7 +126,7 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
 - 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.
+- Note - `<plugin_name>` is cases sensitive. Allowed values are stated [here](plugin/intro.md) in the `Rust Crate` column. The logic is that the release name should be the same.
 - Note - It's the same as the WasmEdge version if not specified.
 
 ### DIST

docs/contribute/internal.md

@@ -8,18 +8,18 @@ sidebar_position: 6
 
 ```mermaid
 graph TD
-    A[Wasm] -->|From files or buffers| B(Loader)
-    B -->|Create Wasm AST| C(Validator)
-    C -->|Validate Wasm Module| D[Instantiator]
-    D -->|Create Wasm instances| E{AOT section found?}
+    A[WASM] -->|From files or buffers| B(Loader)
+    B -->|Create WASM AST| C(Validator)
+    C -->|Validate WASM Module| D[Instantiator]
+    D -->|Create WASM instances| E{AOT section found?}
     E -->|Yes| F[AOT Engine]
     E -->|No| G[Interpreter Engine]
-    F <-->|Execute Wasm| H[WasmEdge Engine]
-    G <-->|Execute Wasm| H[WasmEdge Engine]
+    F <-->|Execute WASM| H[WasmEdge Engine]
+    G <-->|Execute WASM| H[WasmEdge Engine]
     H -->|Host Function Call / Access Runtime Data| H1[WasmEdge Runtime]
     H1 <-->|Call Host Functions| I[Host Functions]
     H1 <-->|Access Runtime Data| J[Runtime Data Manager]
-    I <-->|System Call| I1[Wasm System Interface, WASI]
+    I <-->|System Call| I1[WASM System Interface, WASI]
     I <-->|AI-related Function Call| I2[WASI-NN]
     I <-->|Crypto-related Function Call| I3[WASI-Crypto]
     I <-->|Socket-related Function Call| I4[WasmEdge-WASI-Socket]

docs/contribute/plugin/develop_plugin_c.md

@@ -8,7 +8,7 @@ WasmEdge provides a C++ based API for registering extension modules and host fun
 
 ## Prerequisites
 
-For developing the WasmEdge plug-in in C API, please [install WasmEdge](/develop/build-and-run/install.md) first.
+For developing the WasmEdge plug-in in C API, please [install WasmEdge](../../start/install.md#install) first.
 
 ## Example
 
@@ -18,11 +18,11 @@ 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/latest.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).
 
 <!-- prettier-ignore -->
 :::note
-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.
+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.
 :::
 
 ```c

docs/contribute/plugin/intro.md

@@ -24,14 +24,14 @@ There are several plug-in releases with the WasmEdge official releases. Please c
 
 | Plug-in | Rust Crate | Released Platforms | Build Steps |
 | --- | --- | --- | --- |
-| WasmEdge-Process | [wasmedge_process_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.0`) | [Build Wtih WasmEdge-Process](/contribute/source/plugin/process) |
-| [WASI-Crypto][] | [wasi-crypto][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.1`) | [Build With WASI-Crypto](/contribute/source/plugin/wasi_crypto) |
-| [WASI-NN with OpenVINO backend](/develop/rust/ai_inference/openvino) | [wasi-nn][] | `ubuntu 20.04 x86_64` (since `0.10.1`) | [Build With WASI-NN](/contribute/source/plugin/wasi_nn#get-wasmedge-with-wasi-nn-plug-in-openvino-backend) |
-| [WASI-NN with PyTorch backend](/develop/rust/ai_inference/pytorch) | [wasi-nn][] | `ubuntu 20.04 x86_64` (since `0.11.1`) | [Build With WASI-NN](/contribute/source/plugin/wasi_nn#build-wasmedge-with-wasi-nn-pytorch-backend) |
-| [WASI-NN with TensorFlow-Lite backend](/develop/rust/ai_inference/pytorch) | [wasi-nn][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.11.2`) | [Build With WASI-NN](/contribute/source/plugin/wasi_nn#build-wasmedge-with-wasi-nn-tensorflow-lite-backend) |
-| WasmEdge-Image | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-Image](/contribute/source/plugin/image) |
-| WasmEdge-Tensorflow | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-Tensorflow](/contribute/source/plugin/tensorflow) |
-| WasmEdge-TensorflowLite | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-TensorflowLite](/contribute/source/plugin/tensorflowlite) |
+| WasmEdge-Process | [wasmedge_process_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.0`) | [Build Wtih WasmEdge-Process](../source/plugin/process.md) |
+| [WASI-Crypto][] | [wasi-crypto][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.1`) | [Build With WASI-Crypto](../source/plugin/wasi_crypto.md) |
+| [WASI-NN with OpenVINO backend](../../develop/rust/wasinn/openvino.md) | [wasi-nn][] | `ubuntu 20.04 x86_64` (since `0.10.1`) | [Build With WASI-NN](../source/plugin/wasi_nn.md#build-wasmedge-with-wasi-nn-openvino-backend) |
+| [WASI-NN with PyTorch backend](../../develop/rust/wasinn/pytorch.md) | [wasi-nn][] | `ubuntu 20.04 x86_64` (since `0.11.1`) | [Build With WASI-NN](../source/plugin/wasi_nn#build-wasmedge-with-wasi-nn-pytorch-backend) |
+| [WASI-NN with TensorFlow-Lite backend](../../develop/rust/wasinn/tensorflow_lite.md) | [wasi-nn][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.11.2`) | [Build With WASI-NN](../source/plugin/wasi_nn#build-wasmedge-with-wasi-nn-tensorflow-lite-backend) |
+| WasmEdge-Image | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-Image](../source/plugin/image.md) |
+| WasmEdge-Tensorflow | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-Tensorflow](../source/plugin/tensorflow.md) |
+| WasmEdge-TensorflowLite | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-TensorflowLite](../source/plugin/tensorflowlite.md) |
 
 <!-- prettier-ignore -->
 :::note

docs/contribute/source/build_from_src.md

@@ -6,15 +6,15 @@ sidebar_position: 1
 
 Please follow this guide to build and test WasmEdge from the source code.
 
-- [Linux](../source/os/linux.md)
-- [MacOS](../source/os/macos.md)
-- [Windows](../source/os/windows.md)
-- [Android](../../category/build-and-run-wasmedge-on-android)
-- [OpenWrt](../source/os/openwrt.md)
-- [RISC-V](../source/os/riscv64.md)
-- [OpenHarmony](../source/os/openharmony.md)
-- [seL4](../source/os/sel4)
-- [Raspberry Pi](../source/os/raspberrypi.md)
+- [Linux](os/linux.md)
+- [MacOS](os/macos.md)
+- [Windows](os/windows.md)
+- [Android](/category/build-and-run-wasmedge-on-android)
+- [OpenWrt](os/openwrt.md)
+- [RISC-V](os/riscv64.md)
+- [OpenHarmony](os/openharmony.md)
+- [seL4](os/sel4)
+- [Raspberry Pi](os/raspberrypi.md)
 
 <!-- prettier-ignore -->
 :::note
@@ -34,7 +34,7 @@ WasmEdge provides various tools for enabling different runtime environments for
    - To disable building the ahead-of-time compiler only, you can set the CMake option `WASMEDGE_BUILD_AOT_RUNTIME` to `OFF`.
 
    <!-- prettier-ignore -->
-   :::note 
+   :::note
    The usage of `wasmedgec` is equal to `wasmedge compile`. We decide to deprecate `wasmedgec` in the future.
    :::
 
@@ -44,7 +44,7 @@ WasmEdge provides various tools for enabling different runtime environments for
    - To disable building just the shared library, you can set the CMake option `WASMEDGE_BUILD_SHARED_LIB` to `OFF`.
 4. `ssvm-qitc` is for AI applications and supports the ONNC runtime for AI models in the ONNX format.
    - If you want to try `ssvm-qitc`, please refer to [ONNC-Wasm](https://github.com/ONNC/onnc-wasm) project to set up the working environment and tryout several examples.
-   - And here is our [tutorial for ONNC-Wasm project(YouTube Video)](https://www.youtube.com/watch?v=cbiPuHMS-iQ).
+   - And here is our [tutorial for ONNC-WASM project(YouTube Video)](https://www.youtube.com/watch?v=cbiPuHMS-iQ).
 
 ## CMake Building Options
 
@@ -91,12 +91,12 @@ Developers can set the CMake options to customize the WasmEdge building.
 
 Developers can follow the steps to build WasmEdge with plug-ins from source.
 
-- [WASI-NN (OpenVINO, PyTorch, or TensorFlow-Lite backends)](../source/plugin/wasi_nn.md)
-- [WASI-Crypto](../source/plugin/wasi_crypto.md)
-- [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)
+- [WASI-NN (OpenVINO, PyTorch, or TensorFlow-Lite backends)](plugin/wasi_nn.md)
+- [WASI-Crypto](plugin/wasi_crypto.md)
+- [WasmEdge-Image](plugin/image.md)
+- [WasmEdge-TensorFlow](plugin/tensorflow.md)
+- [WasmEdge-TensorFlowLite](plugin/tensorflowlite.md)
+- [WASI-Logging](plugin/wasi_logging.md)
 
 ## Run Tests
 

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

@@ -67,21 +67,21 @@ adb push WasmEdge-tensorflow-tools /data/local/tmp
 
 ### Sample application
 
-In this example, we will demonstrate a standard [WasmEdge Tensorflow-Lite sample application](https://github.com/second-state/wasm-learning/tree/master/rust/birds_v1). It can recognize and classify the bird type from a JPG or PNG picture of a bird. The explanation of the source code can be [found here](/develop/rust/ai_inference/tensorflow_lite).
+In this example, we will demonstrate a standard [WasmEdge Tensorflow-Lite sample application](https://github.com/second-state/wasm-learning/tree/master/rust/birds_v1). It can recognize and classify the bird type from a JPG or PNG picture of a bird. The explanation of the source code can be [found here](/develop/rust/wasinn/tensorflow_lite).
 
 ```bash
 git clone https://github.com/second-state/wasm-learning.git
 cd wasm-learning/rust/birds_v1
 ```
 
-Use the `cargo` command to build a Wasm bytecode file from the Rust source code. The Wasm file is located at `target/wasm32-wasi/release/birds_v1.wasm`.
+Use the `cargo` command to build a WASM bytecode file from the Rust source code. The WASM file is located at `target/wasm32-wasi/release/birds_v1.wasm`.
 
 ```bash
 rustup target add wasm32-wasi
 cargo build --release --target=wasm32-wasi
 ```
 
-Push the Wasm bytecode file, tensorflow lite model file, and the test bird picture file onto the Android device using `adb`.
+Push the WASM bytecode file, tensorflow lite model file, and the test bird picture file onto the Android device using `adb`.
 
 ```bash
 adb push target/wasm32-wasi/release/birds_v1.wasm /data/local/tmp/WasmEdge-tensorflow-tools
@@ -121,7 +121,7 @@ Output tensor nums: 1
         tensor byte size: 965
 ```
 
-Use the extended WasmEdge Runtime in `wasmedge-tensorflow-lite` to execute the compiled Wasm program on the Android device. It loads the Tensorflow Lite model and bird image, and outputs the bird classification and its confidence.
+Use the extended WasmEdge Runtime in `wasmedge-tensorflow-lite` to execute the compiled WASM program on the Android device. It loads the Tensorflow Lite model and bird image, and outputs the bird classification and its confidence.
 
 ```bash
 sirius:/data/local/tmp/WasmEdge-tensorflow-tools $ chmod 777 wasmedge-tensorflow-lite

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

@@ -31,7 +31,7 @@ To compile programs with the wasmedge-tensorflow c api, you need to install the
 
 ## Review of source code
 
-The [`test.c`](https://github.com/second-state/wasm-learning/blob/master/android/test.c) uses the wasmedge-tensorflow c api to run a WebAssembly function. The WebAssembly file `birds_v1.wasm` is compiled from Rust source code and [explained here](/develop/rust/ai_inference/tensorflow_lite).
+The [`test.c`](https://github.com/second-state/wasm-learning/blob/master/android/test.c) uses the wasmedge-tensorflow c api to run a WebAssembly function. The WebAssembly file `birds_v1.wasm` is compiled from Rust source code and [explained here](/develop/rust/wasinn/tensorflow_lite).
 
 ```c
 #include <wasmedge/wasmedge.h>

docs/contribute/source/os/linux.md

@@ -23,7 +23,7 @@ You can use the following commands to get our latest docker image [from dockerhu
 docker pull wasmedge/wasmedge # Pulls the latest - wasmedge/wasmedge:latest
 ```
 
-Or you can pull with the [available tags](/contribute/source/docker.md#docker-images-for-building-wasmedge).
+Or you can pull with the [available tags](../docker.md#docker-images-for-building-wasmedge).
 
 ### Install Dependencies on Ubuntu Manually