Docs/plugin pages#308
Conversation
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
…ew comments Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
hydai
left a comment
There was a problem hiding this comment.
You are adding new pages without links from the existing table.
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
|
Done! Added the missing plugins to the table in plugins.md and the build guide in build_from_src.md |
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR expands the WasmEdge documentation by adding build-from-source pages for several plug-ins and updating the plug-in index pages so users can discover and navigate to those new docs more easily. It also adds a new “Garbage Collection” extension page under WasmEdge Extensions.
Changes:
- Added new plug-in build documentation pages for WASI-HTTP, WASI-Poll, Wasm-BPF, WasmEdge-FFmpeg, WasmEdge-OCR, WasmEdge-OpenCVMini, WasmEdge-StableDiffusion, and WasmEdge-zlib.
- Updated the “WasmEdge Plug-ins” index table to replace placeholders and include the newly documented plug-ins.
- Added a new “Garbage Collection” extension page and linked the new plug-in docs from the build-from-source index.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/start/wasmedge/extensions/plugins.md | Replaces placeholder plug-in entries with descriptions and links to new build docs; adds several newly documented plug-ins. |
| docs/start/wasmedge/extensions/gc.md | Adds a new “Garbage Collection” extension documentation page. |
| docs/contribute/source/plugin/wasi_http.md | Adds build-from-source instructions for the WASI-HTTP plug-in. |
| docs/contribute/source/plugin/wasi_poll.md | Adds build-from-source instructions for the WASI-Poll plug-in. |
| docs/contribute/source/plugin/wasm_bpf.md | Adds build-from-source instructions for the Wasm-BPF plug-in. |
| docs/contribute/source/plugin/wasmedge_ffmpeg.md | Adds build-from-source instructions for the WasmEdge-FFmpeg plug-in. |
| docs/contribute/source/plugin/wasmedge_ocr.md | Adds build-from-source instructions for the WasmEdge-OCR plug-in. |
| docs/contribute/source/plugin/wasmedge_opencvmini.md | Adds build-from-source instructions for the WasmEdge-OpenCVMini plug-in. |
| docs/contribute/source/plugin/wasmedge_stablediffusion.md | Adds build-from-source instructions for the WasmEdge Stable Diffusion plug-in (including optional accelerators). |
| docs/contribute/source/plugin/wasmedge_zlib.md | Adds build-from-source instructions for the WasmEdge zlib plug-in. |
| docs/contribute/source/build_from_src.md | Adds links to the newly added plug-in build pages from the build-from-source index. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
|
Fixed: corrected FFmpeg capitalization to WasmEdge-FFmpeg, renamed WasmEdge-OpenCV to WasmEdge-OpenCVMini with updated description, added version info to new plugin entries, and changed gc.md sidebar_position to 4. |
|
Please resolve the review threads if you already fixed them. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ankit <ankiittt15@gmail.com>
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
|
The GC page was added as part of PR #306 but ended up here due to branch overlap. Happy to move it if preferred. |
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
|
|
||
| ## Build WasmEdge with WasmEdge-FFmpeg Plug-in | ||
|
|
||
| To enable the WasmEdge-FFmpeg plug-in, developers need to [build WasmEdge from source](../os/linux.md) with the cmake option `-DWASMEDGE_PLUGIN_FFMPEG=ON`. |
|
|
||
| ## Build WasmEdge with WasmEdge-OpenCVMini Plug-in | ||
|
|
||
| To enable the WasmEdge-OpenCVMini plug-in, developers need to [build WasmEdge from source](../os/linux.md) with the cmake option `-DWASMEDGE_PLUGIN_OPENCVMINI=ON`. |
|
|
||
| ## Build WasmEdge with WasmEdge-OCR Plug-in | ||
|
|
||
| To enable the WasmEdge-OCR plug-in, developers need to [build WasmEdge from source](../os/linux.md) with the cmake option `-DWASMEDGE_PLUGIN_OCR=ON`. |
|
|
||
| ## Build WasmEdge with the zlib Plug-in | ||
|
|
||
| To enable the WasmEdge zlib plug-in, developers need to [build WasmEdge from source](../os/linux.md) with the cmake option `-DWASMEDGE_PLUGIN_ZLIB=ON`. |
|
|
||
| ## Build WasmEdge with the Stable Diffusion Plug-in | ||
|
|
||
| To enable the WasmEdge Stable Diffusion plug-in, developers need to [build WasmEdge from source](../os/linux.md) with the cmake option `-DWASMEDGE_PLUGIN_STABLEDIFFUSION=ON`. |
|
|
||
| ## Build WasmEdge with WASI-HTTP Plug-in | ||
|
|
||
| To enable the WasmEdge WASI-HTTP plug-in, developers need to [build WasmEdge from source](../os/linux.md) with the cmake option `-DWASMEDGE_PLUGIN_WASI_HTTP=ON`. |
|
|
||
| ## Build WasmEdge with WASI-Poll Plug-in | ||
|
|
||
| To enable the WasmEdge WASI-Poll plug-in, developers need to [build WasmEdge from source](../os/linux.md) with the cmake option `-DWASMEDGE_PLUGIN_WASI_POLL=ON`. |
| | [WASI-HTTP](../../../contribute/source/plugin/wasi_http.md) | HTTP client and server support for WebAssembly applications. | `manylinux2014 (x86_64, aarch64)`<br/>`ubuntu 20.04 (x86_64)`<br/>`darwin (x86_64, arm64)`<br/>(since `0.13.0`) | Rust | [Steps](../../../contribute/source/plugin/wasi_http.md) | | ||
| | [WASI-Poll](../../../contribute/source/plugin/wasi_poll.md) | Polling API for asynchronous I/O in WebAssembly applications. | `manylinux2014 (x86_64, aarch64)`<br/>`ubuntu 20.04 (x86_64)`<br/>`darwin (x86_64, arm64)`<br/>(since `0.13.0`) | Rust | [Steps](../../../contribute/source/plugin/wasi_poll.md) | |
Closes #307
Added documentation pages for the following plug-ins: