wasmedge / docs

WasmEdge Docs

This repo contains technical documentation for the WasmEdge Runtime project. The documentation website built from this repo is published https://wasmedge.org/docs/, check it out!

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:

   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:

   npm install

3. Start the development server: Once the dependencies are installed, you can start the development server by running the following command:

   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/.

That's it! You should now have a local instance of the WasmEdge Docs running on your machine.

docs's Issues

GSoD workplace: Create new WasmEdge plug-in contributor guides in C, C++, and Rust

Project Name: Create new WasmEdge plug-in contributor guides in C, C++, and Rust

Description:
This issue serves as a centralized place to track the progress of the WasmEdge plug-in contributor guides project, which is part of the Google Season of Docs (GSoD) program. The objective of this project is to create comprehensive guides for developers who want to contribute to the WasmEdge ecosystem by implementing plug-ins in C, C++, or Rust.

The purpose of this issue is to keep a record of the pull requests (PRs) submitted by me throughout the course of this project. By linking the PRs here, it will be easier to track and review the progress and provide feedback as needed.

Project Details:

• GSoD Project Name: Create new WasmEdge plug-in contributor guides in C, C++, and Rust
• Contributor: @mhmohona
• Mentor: @juntao, @alabulei1, @q82419

Outline

• Getting Started with WasmEdge Plugins

  • What is a WasmEdge plugin?
  • How can WasmEdge plugins be used?
  • Benefits of using WasmEdge Plug-in System

• Developing WasmEdge Plugins

  • Requirements for developing a WasmEdge plugin
  • Choosing a programming language
    • C
    • C++
    • Rust
  • Setting up the development environment
  • Creating a WasmEdge plugin project
  • Defining the plugin API
  • Implementing the plugin API
  • Compiling the WasmEdge plugin

• WasmEdge Plugin API Reference

  • Loading a WasmEdge plugin
  • Registering the plugin API
  • Importing the plugin modules
  • Sample application that uses a WasmEdge plugin
  • Examples of WasmEdge Plug-ins
    • Overview of the WasmEdge Plug-ins
    • WasmEdge-Process Plug-in
    • WASI-Crypto Plug-in
    • WASI-NN Plug-in with OpenVINO backend
    • WASI-NN Plug-in with PyTorch backend
    • WASI-NN Plug-in with TensorFlow-Lite backend
    • WasmEdge-HttpsReq Plug-in

• Understanding WasmEdge Plugins

  • Best Practices for Developing WasmEdge Plug-ins
    • Security best practices
    • Performance best practices
    • Compatibility best practices
    • Documentation best practices
  • Error handling
    • How to handle errors in WasmEdge plugins
    • Tips for avoiding common error-handling pitfalls
  • Debugging
  • How to debug WasmEdge plugins
  • Tips for using WasmEdge's debugging tools
  • Testing
    • How to test WasmEdge plugins
    • Tips for writing effective WasmEdge unit tests

• Conclusion

• Recap of WasmEdge Plug-in System

• Future Development Roadmap

PRs Submitted:

• #105
• #106
• #107
• #102

Add docs link for each plugin

Is your feature request related to a problem? Please describe.

Readers can find the plugins crate on the plugin page, but it's difficult to locate the documentation on how to use them. Adding a link for each plugin would be helpful.
https://wasmedge.org/docs/start/wasmedge/extensions/plugins/#official-released-plug-ins

Describe the solution you'd like.

As an example, it would be beneficial to include a hyperlink https://wasmedge.org/docs/develop/rust/wasinn/pytorch for the WASI-NN platform that utilizes the Pytorch backend.

Describe alternatives you've considered

No response

Additional context.

No response

Bug: Package file has duplicate dev dependencies

Describe the bug.

The package.json file has duplicate devDependency of "@docusaurus/module-type-aliases": "^2.4.0",

Describe the steps to reproduce the behavior.

• Go to https://github.com/WasmEdge/docs/blob/main/package.json
• Go to L43
• Go to L48
• L43 & L48 have the same dependencies which need to be removed

Expected behavior.

Duplicate devDependencies should be removed

Screenshots.

Operating Environment

macOS

Additional Information

Issue came from #71

Bug: Footer Logo and Header Logo should be the same

Describe the bug.

The footer and header menu logo at https://wasmedge.org/docs are not the same and this needs to be fixed

Describe the steps to reproduce the behavior.

Go to https://wasmedge.org/docs and Scroll down to the footer, you would notice that the logo is different than the one in the header menu

Expected behavior.

Logos should be the same

Screenshots.

Operating Environment

macOS

Additional Information

No response

[Feature] - Docusaurus SEO for Docs

Description:

Work on improving the SEO of the site through docusaurus

More Info: https://docusaurus.io/docs/seo

Feature Request: Add GA code to docs

Is your feature request related to a problem? Please describe.

Now we can't monitor page views and event for wasmedge.org/docs. We need to add this freature.

Describe the solution you'd like.

It seems that we need to install a plugin to enable this feature. facebook/docusaurus#7221

Describe alternatives you've considered

No response

Additional context.

No response

[DOCS] missing crun instructions in https://wasmedge.org/docs/develop/deploy/podman/#prerequisites

Description

Summary
Step 3 of https://wasmedge.org/docs/develop/deploy/podman/#prerequisites: It seems like some instructions are missing.

Build and configure crun with WasmEdge support

Next, configure and build a crun binary with WasmEdge support.

Maybe there should be a git clone, similar to https://wasmedge.org/docs/develop/deploy/oci-runtime/crun/#prerequisites?

Issue refers to:
WasmEdge/WasmEdge#3028

Screenshots

No response

Additional information

No response

Bug: The linter is not the same as the original repo

Describe the bug.

The original repo applied markdown-lint with a custom configuration file.

Configuration file

https://github.com/WasmEdge/WasmEdge/blob/master/.github/linters/.markdown-lint.yml

Just save it as .markdownlint.yaml.

---
###########################
###########################
## Markdown Linter rules ##
###########################
###########################

# Linter rules doc:
# - https://github.com/DavidAnson/markdownlint
#
# Copied from: https://github.com/github/super-linter/blob/main/TEMPLATES/.markdown-lint.yml
#
# Note:
# To comment out a single error:
#   <!-- markdownlint-disable -->
#   any violations you want
#   <!-- markdownlint-restore -->
#

###############
# Rules by id #
###############
MD004: false                  # Unordered list style
MD007:
  indent: 2                   # Unordered list indentation
MD013:
  line_length: 999            # Line length 80 is far to short. We allow soft wrapped paragraphs and raw code outputs
MD026:
  punctuation: ".,;:!。，；:"  # List of not allowed
MD029: false                  # Ordered list item prefix
MD033: false                  # Allow inline HTML
MD036: false                  # Emphasis used instead of a heading

#################
# Rules by tags #
#################
blank_lines: false  # Error on blank lines

Error log

markdownlint-cli2 v0.8.1 (markdownlint v0.29.0)
Finding: **/*.md
Linting: 285 file(s)
Summary: 97 error(s)
.github/PULL_REQUEST_TEMPLATE.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Explanation"]
CONTRIBUTING.md:18 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# <a name="contributing-flow">..."]
CONTRIBUTING.md:28 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
CONTRIBUTING.md:35:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ git commit -s -m “my commit ..."]
CONTRIBUTING.md:42 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
CONTRIBUTING.md:91:62 MD034/no-bare-urls Bare URL used [Context: "https://github.com/WasmEdge/do..."]
i18n/zh/docusaurus-plugin-content-docs/current/contribute/source/os/android/apk.md:7 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "# Call WasmEdge functions from..."]
i18n/zh/docusaurus-plugin-content-docs/current/contribute/source/os/android/apk.md:7 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Call WasmEdge functions from..."]
i18n/zh/docusaurus-plugin-content-docs/current/contribute/source/plugin/httpsreq.md:7 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Build WasmEdge With WasmEdge..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/cli.md:269 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Examples"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:14:3 MD051/link-fragments Link fragments should be valid [Context: "[Create and run a node.js server](#create-and-run-a-node-js-server)"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:21 MD045/no-alt-text Images should have alternate text (alt text)
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:32:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ docker buildx build --platfo..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:75:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ docker push secondstate/rust..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:102 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Build"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:107:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ docker buildx build --platfo..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:145 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Publish"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:150:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ docker push secondstate/node..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:171 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Further reading"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:187 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Build"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:192:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ docker compose up"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:236:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ docker compose up"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:241 MD045/no-alt-text Images should have alternate text (alt text)
i18n/zh/docusaurus-plugin-content-docs/current/develop/build-and-run/docker_wasm.md:279 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Further reading"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/c/simd.md:7 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# WebAssembly SIMD Example in ..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/deploy/cri-runtime/containerd.md:23:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ curl -sSf https://raw.github..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/deploy/cri-runtime/containerd.md:24:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ sudo -E sh -c 'echo "$HOME/...."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/deploy/cri-runtime/containerd.md:25:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ sudo ldconfig"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/deploy/intro.md:17 MD045/no-alt-text Images should have alternate text (alt text)
i18n/zh/docusaurus-plugin-content-docs/current/develop/deploy/intro.md:29 MD045/no-alt-text Images should have alternate text (alt text)
i18n/zh/docusaurus-plugin-content-docs/current/develop/deploy/kubernetes/knative.md:7 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "# Knative"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/deploy/kubernetes/knative.md:7 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Knative"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/deploy/podman.md:68 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Run A simple WASI app"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/getting-started/quick_start_docker.md:26 MD045/no-alt-text Images should have alternate text (alt text)
i18n/zh/docusaurus-plugin-content-docs/current/develop/getting-started/quick_start_redhat.md:25:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ dnf install wasmedge crun-wa..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/javascript/rust.md:170 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Run the example"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/openvino.md:19 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/openvino.md:52 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/openvino.md:59 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/pytorch.md:21 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/pytorch.md:53 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/pytorch.md:60 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/tensorflow_lite.md:19 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/tensorflow_lite.md:49 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/tensorflow_lite.md:56 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/tensorflow_lite.md:75:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ wasmedgec rust/tflite-bird/t..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/ai_inference/tensorflow_lite.md:76:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ wasmedge --dir .:. wasmedge-..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/dapr.md:11 MD045/no-alt-text Images should have alternate text (alt text)
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/dapr.md:28 MD045/no-alt-text Images should have alternate text (alt text)
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/dapr.md:75:1 MD010/no-hard-tabs Hard tabs [Column: 1]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/hello_world.md:55 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Build the WASM bytecode"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/hello_world.md:61 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Run the application from c..."]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:17 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:26 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:41 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:57 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:78 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:86 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:102 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:117 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:138 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:145 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:160 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/client.md:182 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/server.md:28 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/server.md:35 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/http_service/server.md:65 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/setup.md:15 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/setup.md:23 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/setup.md:31 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/socket_networking/client.md:46 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/socket_networking/client.md:134 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/socket_networking/server.md:7:24 MD051/link-fragments Link fragments should be valid [Context: "[client](client) chapter, with the WasmEdge socket API, it is also possible for Rust developers to work directly on the socket level. In order for WasmEdge to become a cloud-native runtime for microservices, it needs to support HTTP servers. So, in this chapter, we will discuss[an HTTP server example](#an-http-server)"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/socket_networking/server.md:84 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/develop/rust/socket_networking/server.md:227 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/embed/c/reference/0.12.0.md:7 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# WasmEdge C 0.12.0 API Docume..."]
i18n/zh/docusaurus-plugin-content-docs/current/embed/go/bindgen.md:193:48 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '.']
i18n/zh/docusaurus-plugin-content-docs/current/embed/overview.md:14 MD045/no-alt-text Images should have alternate text (alt text)
i18n/zh/docusaurus-plugin-content-docs/current/embed/quick-start/install.md:21 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/embed/quick-start/install.md:42 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/embed/quick-start/install.md:64 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/embed/quick-start/wasm-app-in-rust.md:17 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
i18n/zh/docusaurus-plugin-content-docs/current/embed/rust/app.md:7:1 MD034/no-bare-urls Bare URL used [Context: "https://github.com/second-stat..."]
i18n/zh/docusaurus-plugin-content-docs/current/embed/rust/complex_data.md:7:27 MD034/no-bare-urls Bare URL used [Context: "https://github.com/second-stat..."]
i18n/zh/docusaurus-plugin-content-docs/current/embed/rust/function.md:7:1 MD034/no-bare-urls Bare URL used [Context: "https://github.com/second-stat..."]
i18n/zh/docusaurus-plugin-content-docs/current/embed/rust/function.md:9:1 MD034/no-bare-urls Bare URL used [Context: "https://github.com/second-stat..."]
i18n/zh/docusaurus-plugin-content-docs/current/embed/rust/intro.md:7 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# WasmEdge Rust SDK"]
i18n/zh/docusaurus-plugin-content-docs/current/embed/rust/intro.md:21:7 MD051/link-fragments Link fragments should be valid [Context: "[`wasmedge-sdk` Examples](#wasmedge-sdk-examples)"]
i18n/zh/docusaurus-plugin-content-docs/current/embed/rust/intro.md:22:7 MD051/link-fragments Link fragments should be valid [Context: "[`wasmedge-sys` Examples](#wasmedge-sys-examples)"]
i18n/zh/docusaurus-plugin-content-docs/current/embed/witc.md:12:19 MD034/no-bare-urls Bare URL used [Context: "https://github.com/second-stat..."]
README.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "![WasmEdge Logo](https://githu..."]
README.md:5:178 MD034/no-bare-urls Bare URL used [Context: "https://wasmedge.org/docs/"]
README.md:29:138 MD034/no-bare-urls Bare URL used [Context: "http://localhost:3000/docs/"]
src/pages/releases.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "import Tabs from '@theme/Tabs'..."]
src/pages/talks.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "import ReactPlayer from 'react..."]
src/pages/talks.md:25 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]
src/pages/talks.md:51 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]

Describe the steps to reproduce the behavior.

Install markdownlint

npm install markdownlint-cli2 --global

Run markdwonlint with given configuration file

markdownlint-cli2 "**/*.md"

Expected behavior.

Let's refine the configuration file or apply markdown-lint to ensure all markdown files follow the same spec.

Screenshots.

No response

Operating Environment

ProductName:macOS ProductVersion:13.4.1 BuildVersion:22F82

Additional Information

No response

Feature Request: FAQ Page

Is your feature request related to a problem? Please describe.

No response

Describe the solution you'd like.

As a developer of WasmEdge, I believe that having an FAQ section would greatly benefit the community. It would provide a centralized location for addressing common queries, clarifying key concepts, and helping users troubleshoot common issues.

Describe alternatives you've considered

No response

Additional context.

I would like to suggest including the following topics in the FAQ section:

• How does WasmEdge work internally?
• What programming languages are supported by WasmEdge?
• What are the different types of WasmEdge?
• What are the different ways to use WasmEdge?
• What are the different features of WasmEdge?
• What are the performance benefits of using WasmEdge?
• What are the security benefits of using WasmEdge?
• What are the development benefits of using WasmEdge?
• What is the difference between WasmEdge and other Wasm runtimes such as Node.js or WebAssembly?
• Can I use WasmEdge for running serverless functions?
• How do I integrate WasmEdge with other applications and frameworks?
• How do I host a Wasm module on WasmEdge?
• What security features does WasmEdge provide?
• How does WasmEdge handle errors and exceptions in Wasm modules?
• Can I use WasmEdge for machine learning inference?
• How do I debug my Wasm modules running on WasmEdge?

Feature Request: Add docs for building ggml plugin from source

Is your feature request related to a problem? Please describe.

WasmEdge recently added a plugin called ggml to run LLM inference. We need add docs for this plugin.

It should located in the wasi-nn folder. https://wasmedge.org/docs/contribute/source/plugin/wasi_nn

Describe the solution you'd like.

No response

Describe alternatives you've considered

No response

Additional context.

No response

[DOCS] No pages and content for "FAQ" and "Best Practices"

Description

I noticed that there is no content for "Frequently asked questions" and "Best Practices with WasmEdge", in the documentation and I would like to work on this.

For the Frequently asked Questions, I would go through WasmEdge's community channels, make a compilation of the recurring questions, as well as similar ones, along with the solutions provided.

As for the Best Practices, I consider myself a beginner with WasmEdge, so while I can come up with a draft of Best Practices, I would require the help of a community member with more experience to answer questions I will have, and also review my drafts.

I believe that this is going to be a great addition, and improvement to the docs, seeing as both sections are essential in any documentation.

Screenshots

No response

Additional information

No response

Enhance the Readme section

For now, there is very few information added in the Readme.md file. We should enhance this a little bit.

What do you think? @alabulei1

Link is not working

Description

In docs, there is a section comparison between WebAssembly and Docker the provided link is not working.

Screenshots

Additional information

No response

Feature Request: Release Page

Is your feature request related to a problem? Please describe.

Displaying releases at one place for all Wasmedge related projects.

Describe the solution you'd like.

Creating a release page with all the project by fetching Changelog from main repos.

Here is WIP demo for release page: https://render.sahil.world/docs/releases

Describe alternatives you've considered

No response

Additional context.

No response

Bug: Linter not enabled

Describe the bug.

Hence drop the prettier, the markdownlint should be added back.

Reference: #95

Describe the steps to reproduce the behavior.

No response

Expected behavior.

No response

Screenshots.

No response

Operating Environment

MacOS

Additional Information

No response

[DOCS] Missing command for building the plugin using C

Description

Docs writes:

- **Build with Command**: if you choose to build the plug-in using the command line, run the following command in the terminal:

  This command compiles the `testplugin.c` file into a shared library named `libwasmedgePluginTest.so`. The `-std=c11` flag sets the C language standard to C11, and the `-DWASMEDGE_PLUGIN` flag defines the WASMEDGE_PLUGIN macro, which can be used in your code.

So, what is the "following command"?

Screenshots

No response

Additional information

No response

Add a twitter card for WasmEdge/Docs

Is your feature request related to a problem? Please describe.

WasmEdge's docs don't have a preview card.

Describe the solution you'd like.

Follow the instruction from docusarus to add one: https://docusaurus.io/docs/next/api/themes/configuration#meta-image

Describe alternatives you've considered

No response

Additional context.

No response

[DOCS] Footer

Description

Improve footer section by adding logo and important links mentioned in WasmEdge website. I am working on this.

[Feat] - Add Caching Capabilities to Workflow

Description:

The Deploy script here, can be improved by adding caching capabilities to the workflow to reduce the CI time.

[DOCS] The OpenVINO is updated to 2023 edition. Related docs should be updated

Description

See WasmEdge/WasmEdge#2636

The OpenVINO is updated. So we will need to update the corresponding documents.

Screenshots

No response

Additional information

No response

Feature Request: Create Page for WasmEdge talks

Is your feature request related to a problem? Please describe.

As one who got to know about wasm-edge by watching talks, it's difficult to find all the wasm-edge related talks in one place.

Describe the solution you'd like.

Create a /talks pages to list all the wasm-edge related talks in chronological order with related assets to talks like https://github.com/second-state/kubecon-eu-2023.

Describe alternatives you've considered

Creating a YouTube playlist for all the talks.

Additional context.

No response

Issue and PR template

It would be nice to have both Issue and PR template in this repo which will help in formatting the issue and proposed changes in a very informative way to the other contributors and maintainers of this project.

I am willing to take this issue, can you assign it to me @alabulei1

Bug: The Rust codes are not colorized

Describe the bug.

Such as the Rust code in the pages, the code blocks are not colorized.
As the previous docs in mdbook, it should be colorized.

Describe the steps to reproduce the behavior.

No response

Expected behavior.

No response

Screenshots.

No response

Operating Environment

MacOS

Additional Information

No response

[DOCS] install via nix flake

Description

I thought if we document this option, then we can get report about nix problem more frequently. The following command can install WasmEdge directly

nix profile install github:WasmEdge/WasmEdge

Screenshots

No response

Additional information

No response

[DOCS] Update Docker related docs

Description

Docker Desktop released v4.21 today, which changed the way to run WasmEdge containers. We need to update the docs.

Screenshots

No response

Additional information

No response

Feature Request: Add a more detailed section on developing in Go

Is your feature request related to a problem? Please describe.

The Go team has recently released Go 1.21, which has native support for compiling to WASI. Updating the documentation for developing in Go, including more detailed general documentation, especially for Go's newly added support for WASI, would very much benefit devs new to WasmEdge.

This is especially so if the developer requires functionality not provided by the TinyGo standard library, e.g., HTTP.

Describe the solution you'd like.

The solution is, of course, to create a more detailed section on Go development. I will start working on a PR for this soon. I will add an introduction describing the differences between TinyGo and native Go WASI support, using networking via stealthrocket/net and importing host functions in Go 1.21.

Describe alternatives you've considered

No response

Additional context.

No response

[DOCS] Possibly Rustls Plug-in typo

Description

I came across this issue and noticed that the title Rusttls does not seem to align with its content and the crate name - Rustls. Is this intentional or is it a typo? I've found that some references in the documentation use Rusttls. If it's a typo, I can submit a pull request to address this issue.

Screenshots

Additional information

No response

[DOCS] Folder names in repository do not match titles on website

Description

I've noticed that some the folder names in the repository for this project do not match the titles used on the hosted website. This can be confusing for contributors who are trying to locate specific files.

To address this issue, I would like to u[date the folder names to match their corresponding titles on the website. This will improve the organization and clarity of the project for everyone involved.

I would like to take on this task and submit a pull request.

Screenshots

I wanted to edit this page, and I had a little trouble locating it on my machine

It was located in a folder named 'os' which was in the 'Contribute' folder, neither of which are titles in the hosted site.

Additional information

No response

Should we update the extension list on the Release progress page

The current version is https://wasmedge.org/docs/contribute/release#update-the-extensions As far as I know, the NAPI extension is out of date.

Should we change the extension list to the existing plugins? @hydai Please help me figure me out. Thanks.

Discard the old book and migrate the book content to this new repo

Is your feature request related to a problem? Please describe.

The maintainers and community only need one single source for docs. Two docs will make it confused.

Describe the solution you'd like.

For this issue, we have three things to do.

1. Discard the old book, see an ongoing PR 1
   WasmEdge/WasmEdge#2541. I have done most of the things. To avoid double work, please continue your work on this PR.
2. migrate the book content to this new repo since the 0.12.0 release, which needs to create a new PR on WasmEdge/doc
3. How to deal with the links to old books? The links have been everywhere. How to make sure the links still work and can direct users to the right content.

Describe alternatives you've considered

No response

Additional context.

No response

Bug: `lint-staged` script missing for husky pre-commit-hook

Describe the bug.

The pre-commit hook for husky is missing a script to lint staged files for git commit workflow

Describe the steps to reproduce the behavior.

• Clone this repo
• Make some changes with lint issues
• Try committing the change, husky will exit with code 1 similar to the below screenshot

Expected behavior.

Add a lint-staged script to handle and fix the error

Screenshots.

Operating Environment

Windows/macOS/Linux

Additional Information

Credits to @Lucif3r-in at #76 (comment) for noticing this bug :)

GSoD Workspace: Reorganize the contributor guide of WasmEdge

Project

• Title: Reorganize the contributor guide of WasmEdge
• Description: This project aims to create a contributor guide for WasmEdge to help new contributors develop plug-ins. The project involves reviewing the existing documentation and creating new guides and references for the C, C++, and Rust plug-in SDKs. The project will also update the documentation on the new Docusarus-based site, wasmedge.org/docs/. The required content for the contributor guide includes an architectural overview, getting started with contributing, building WasmEdge, testing WasmEdge, fuzzing, building a plug-in, reporting an issue, and proposing a feature request.

Detailed Description:

• Review existing documentation: The first step is to review the existing contributor documentation to identify gaps and improvement areas. This will involve understanding the current documentation structure and content, identifying any outdated or irrelevant information, and making notes on what needs to be updated or added.
• Create an outline: Based on the review, create an outline for the new contributor guide. This outline should cover all the required content mentioned above, with clear headings and subheadings that make it easy for new contributors to navigate and find the information they need.
• Develop new guides and references: For each section of the outline, create new guides and references that provide clear, concise, and actionable information for new contributors. This will involve researching best practices for each topic, providing step-by-step instructions where necessary, and using clear language and visuals to make the information easy to understand.
• Update the documentation: Once the new guides and references are complete, update the documentation on the new Docusarus-based site, wasmedge.org/docs/. This will involve creating new pages for the contributor guide, linking to relevant sections of existing documentation, and making sure that the new content is integrated seamlessly with the existing site design and structure.
• New Features: Add a search field to the documentation through, https://docusaurus.io/docs/search such that users and visitors of the site can easily access the information that they need without going through the whole website.
• Test and refine: Finally, test the new contributor guide with a group of new contributors to identify any remaining issues or areas for improvement. This feedback can be used to refine the guide and make it as effective as possible for new contributors.

Overall, the key to tackling this problem is to focus on creating clear and actionable information that is easy for new contributors to understand and use. By taking a structured approach to review, outlining, developing, and testing the new contributor guide, it should be possible to create a valuable resource that helps WasmEdge attract and retain new contributors.

Project Details

• Contributor: @adithyaakrishna
• Mentor: @yiying, @juntao, @alabulei1

How does it help?

• Easier Project Management
• Clearer Communication
• Maintaining Consistency
• Easier Transfer of Knowledge
• Easier Project Evaluation

Milestones

• Setup basic CI and CD | Migrate to TS
• Upgrade Docusaurus and Add Workflows
• Add Linting Capabilites and Build Checks
• Add Netlify which requires mentors' admin permissions
• Gather Information and Expectations from Mentors
• Gather information from books site to be migrated to docs site
• Migrate books site to docs site.
• Improve SEO
• Remove Old Docs from https://github.com/WasmEdge/WasmEdge/tree/master/docs/book
• Gather content to be updated across the new docs site
• Work with mentors to add new content for the contribution guide
• Work with mentors to add new content to the docs site
• Add versioning capability to the project

Detailed Outline

• Review PRs related to Docs changes: Collaborate with reviewers to review and provide feedback on PRs related to documentation changes in the WasmEdge project.
• Theme customization: Change the overall theme of the Docusaurus site to align with the WasmEdge project colors, ensuring a consistent visual identity.
• Contribution Guide for WasmEdge projects: Collaborate with mentors to create a comprehensive contribution guide for WasmEdge projects. Include the following sections in the contribution guide:
  • Getting started with the project
  • Cloning/Forking the project
  • Local setup
  • Contribution workflow
  • Creating PRs and working on requested changes
  • Documenting new features
  • Testing and fuzzing
• Contributor Guide Outline:
  • Architectural overview
  • Getting started with contributing
  • Building WasmEdge
  • Testing WasmEdge
  • Fuzzing
  • Reporting an issue
  • Proposing a feature request
• Enhancements to Documentation:
  • Add a Bots page to inform users about the bots used in the WasmEdge community.
  • Incorporate screenshots and images to make the documentation more visually appealing, particularly in sections with lengthy text-based content.
  • Include flowcharts or architecture diagrams to enhance the visual clarity of the documentation.
  • Update the landing page to improve user understanding and navigation.
• Standardization and Compliance:
  • Add Contributing guides, License, and Code of Conduct to all WasmEdge projects, aligning them with CNCF Standards.
  • (Optional - Extended Scope) Add Interactive Video for the whole contributing flow.
• Netlify Setup and Streamlined Workflow: Work with mentors and reviewers to set up Netlify for deploy previews, enabling a streamlined process for merging MRs related to documentation changes. (@alabulei1 Would need your help with this)
• GitHub Actions and Automation:
  • Implement new GitHub actions to automate the labeling of PRs and issues, reducing the workload of maintainers.
  • Ensure that any content changes trigger the CI workflow, excluding the readme.md file.

Progress

• Pre-GSoD Tasks - Before May 10th 2023 - #93 (comment)
• GSoD Period - May 10th to May 22nd 2023 - #93 (comment)
• GSoD Period - May 23rd to June 10th 2023 - #93 (comment)
• GSoD Period - June 11th to June 27th - #93 (comment)
• GSoD Period - June 27th to July 10th - #93 (comment)

[DOCS] rust AI inference page missing

Description

The original existed link https://wasmedge.org/docs/develop/rust/ai_inference/tensorflow_lite is disappeared, it should have a corresponding page for rust AI inference

Screenshots

No response

Additional information

No response

Remove the GC proposal from the WASI proposal section.

The GC proposal is a WebAssembly proposal, not a WASI proposal.

https://wasmedge.org/docs/develop/wasmedge/extensions/proposals/#wasi-proposals

Feature Request: An efficient way to update WasmEdge's version

Is your feature request related to a problem? Please describe.

When WasmEdge has released a new version, we should ensure everything in this doc uses the latest version of WasmEdge.

There are 12 files that need to be synced with the latest version of WasmEdge. It would be complex to maintain all 12 files.

Describe the solution you'd like.

Can we think of a simple way to update the version of WasmEdge? For example, we can first set a general parameter called {{ wasmedge_version }}. Then we update ``{{ wasmedge_version }}` equals the latest version of WasmEdge. Finally, all the docs are using the same and lastest version of WasmEdge.

This would be much easier to update WasmEdge's version. Any feedback is welcome.

Describe alternatives you've considered

No response

Additional context.

No response

[DOCS] Build Failing for the latest merge pull request #40

Description

The build is failing with latest commit it is caused due to the https://github.com/WasmEdge/docs/actions/runs/4839635400/jobs/8624785967#step:7:32

From what I can concluded it is caused because of the remove footer links which I mentioned #40 (review) was later replaced by the following code which caused the issue

https://github.com/WasmEdge/docs/blob/d84fbbd2865786b6ee974a0c1b02ac6cdea7bdd2/docusaurus.config.js#LL140C31-L143C31

It is acting as baseurl which results in broken link for other locales.

I will create a PR to fix this issue ASAP!

Screenshots

No response

Additional information

No response

Add ebpf and rusttls on the plugin introductions page

https://wasmedge.org/docs/start/wasmedge/extensions/plugins

Bug: Mermaid not rendered

Describe the bug.

The mermaid graph in this page is not rendered.

Describe the steps to reproduce the behavior.

No response

Expected behavior.

Render the graph.

Screenshots.

No response

Operating Environment

MacOS

Additional Information

No response

Align with the theme

Description

Align the theme of this website with the WasmEge website
For now changes will involve with Fonts and Color Sheme.

Feature Request: the search box is missing

Once we have a search box for the docs. See the PR #31

However the search box is missing now. I'm not sure which PR removes the search box. We need to add this feature again.

Feature Request: Add a chapter about the Wasm GC proposal

Is your feature request related to a problem? Please describe.

WasmEdge 0.1.4.0 supports GC proposal now. We should add a tutorial about this.

Describe the solution you'd like.

No response

Describe alternatives you've considered

No response

Additional context.

No response

The latest CI fails

Describe the bug.

The latest CI fails https://github.com/WasmEdge/docs/actions/runs/5066235102/jobs/9095783281

Describe the steps to reproduce the behavior.

No response

Expected behavior.

No response

Screenshots.

No response

Operating Environment

GitHub Action

Additional Information

No response

[DOCS] Enable Search for the dcos

Description

Now we don't support search for the docs. However, it's a must-have thing for users to find the content they need quickly.

Screenshots

No response

Additional information

Need to apply a token from docusaurus.

[CI] Deploy CI should be triggered when a PR is raised

Is your feature request related to a problem? Please describe.

It happened several times that I found the Deploy CI failed after the PR was merged. This requires the contributor to raising another PR to fix CI, which is not efficient.

Describe the solution you'd like.

When a new PR is raised, the Deploy CI should be triggered. So the contributor can know whether their code works.

Describe alternatives you've considered

No response

Additional context.

No response

An issue in Built-in modules docs

Description

Hi.
The bash script explained in the following to map the host path to /modules directory is wrong.

docs/docs/develop/javascript/modules.md

Line 20 in 80b2a5f

wasmedge --dir /host/os/path/to/modules:/modules wasmedge_quickjs.wasm example_js/hello.js WasmEdge Runtime

According to the wasmedge --help, it's correct to write wasmedge --dir /modules:/host/os/path

Screenshots

Additional information

No response