Docs/plugin pages#308
Conversation
hydai
left a comment
There was a problem hiding this comment.
You are adding new pages without links from the existing table.
|
Done! Added the missing plugins to the table in plugins.md and the build guide in build_from_src.md |
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.
|
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. |
|
The GC page was added as part of PR #306 but ended up here due to branch overlap. Happy to move it if preferred. |
a805e21 to
4f97b9b
Compare
|
@hydai, been a while I opened the pr and solved the issues with it...mind looking at it, thanks. |
|
If you have already addressed the review comments, please resolve the threads. |
|
ive done them |
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>
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
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>
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
…I spec links Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
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>
Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
34c4ab7 to
b1f8125
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Comments suppressed due to low confidence (2)
docs/start/wasmedge/extensions/plugins.md:1
- The new rows introduce an explicit numeric prefix (e.g.,
27 || ...) while surrounding rows keep the first column empty (|| ...). This inconsistency is likely to render as a malformed/shifted table (or at least confuse readers) depending on how the table is structured. Consider either (a) numbering all rows consistently in the first column, or (b) removing the numeric prefixes from the new rows and keeping the first column blank across the table.
---
docs/start/wasmedge/extensions/plugins.md:1
- In the 'Language/Binding' column, existing entries often link to the relevant Rust crate or repo (e.g.,
[Rust](...)and sometimes a version). The new rows use plainRust, which is inconsistent and less actionable. If there are corresponding crates/repos for these plug-ins, consider linking them; otherwise consider using a consistent label format (e.g.,Rust (in-tree)orRust (no published crate)) to avoid implying a crate link exists.
---
- wasm_bpf.md: clarify build link points to Linux-specific guide - wasi_http.md: clarify only outbound HTTP requests are supported - wasmedge_zlib.md: note .dylib extension on macOS - gc.md: remove misleading Rust-specific target triple wording Signed-off-by: Ankit Ram <ankiittt15@gmail.com>
Closes #307
Added documentation pages for the following plug-ins:
Also added a documentation page for the WebAssembly Garbage Collection
(GC) proposal support, introduced in WasmEdge v0.14.0.