Skip to content

Docs/plugin pages#308

Open
Ankitdotraider wants to merge 13 commits into
WasmEdge:mainfrom
Ankitdotraider:docs/plugin-pages
Open

Docs/plugin pages#308
Ankitdotraider wants to merge 13 commits into
WasmEdge:mainfrom
Ankitdotraider:docs/plugin-pages

Conversation

@Ankitdotraider

@Ankitdotraider Ankitdotraider commented Jun 19, 2026

Copy link
Copy Markdown

Closes #307

Added documentation pages for the following plug-ins:

  • wasi_http
  • wasi_poll
  • wasm_bpf
  • wasmedge_ffmpeg
  • wasmedge_ocr
  • wasmedge_opencvmini
  • wasmedge_stablediffusion
  • wasmedge_zlib

Also added a documentation page for the WebAssembly Garbage Collection
(GC) proposal support, introduced in WasmEdge v0.14.0.

@hydai hydai left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are adding new pages without links from the existing table.

@Ankitdotraider

Copy link
Copy Markdown
Author

Done! Added the missing plugins to the table in plugins.md and the build guide in build_from_src.md

Comment thread docs/start/wasmedge/extensions/proposals.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/start/wasmedge/extensions/plugins.md Outdated
Comment thread docs/start/wasmedge/extensions/plugins.md Outdated
Comment thread docs/start/wasmedge/extensions/plugins.md Outdated
Comment thread docs/start/wasmedge/extensions/gc.md
@Ankitdotraider

Copy link
Copy Markdown
Author

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.

@hydai

hydai commented Jun 23, 2026

Copy link
Copy Markdown
Member

Please resolve the review threads if you already fixed them.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 9 comments.

Comment thread docs/contribute/source/plugin/wasi_http.md
Comment thread docs/contribute/source/plugin/wasi_poll.md
Comment thread docs/contribute/source/plugin/wasm_bpf.md
Comment thread docs/contribute/source/plugin/wasm_bpf.md
Comment thread docs/contribute/source/plugin/wasmedge_ffmpeg.md
Comment thread docs/contribute/source/plugin/wasmedge_ocr.md
Comment thread docs/contribute/source/plugin/wasmedge_opencvmini.md
Comment thread docs/contribute/source/build_from_src.md Outdated
Comment thread docs/start/wasmedge/extensions/gc.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Comment thread docs/start/wasmedge/extensions/gc.md
Comment thread docs/contribute/source/build_from_src.md
Comment thread docs/start/wasmedge/extensions/gc.md
@Ankitdotraider

Copy link
Copy Markdown
Author

The GC page was added as part of PR #306 but ended up here due to branch overlap. Happy to move it if preferred.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.

Comment thread docs/contribute/source/plugin/wasmedge_ffmpeg.md Outdated
Comment thread docs/contribute/source/plugin/wasmedge_opencvmini.md Outdated
Comment thread docs/contribute/source/plugin/wasmedge_ocr.md Outdated
Comment thread docs/contribute/source/plugin/wasmedge_zlib.md Outdated
Comment thread docs/contribute/source/plugin/wasmedge_stablediffusion.md Outdated
Comment thread docs/contribute/source/plugin/wasi_http.md Outdated
Comment thread docs/contribute/source/plugin/wasi_poll.md Outdated
Comment thread docs/start/wasmedge/extensions/plugins.md Outdated
@Ankitdotraider

Copy link
Copy Markdown
Author

@hydai, been a while I opened the pr and solved the issues with it...mind looking at it, thanks.

@hydai

hydai commented Jul 15, 2026

Copy link
Copy Markdown
Member

If you have already addressed the review comments, please resolve the threads.

@Ankitdotraider

Copy link
Copy Markdown
Author

ive done them

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Comment thread docs/start/wasmedge/extensions/gc.md
Comment thread docs/contribute/source/plugin/wasm_bpf.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Comment thread docs/contribute/source/plugin/wasmedge_stablediffusion.md Outdated
Ankitdotraider and others added 12 commits July 18, 2026 00:47
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>
@hydai
hydai requested a review from Copilot July 20, 2026 15:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 plain Rust, 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) or Rust (no published crate)) to avoid implying a crate link exists.
---

Comment thread docs/contribute/source/plugin/wasm_bpf.md Outdated
Comment thread docs/contribute/source/plugin/wasi_http.md Outdated
Comment thread docs/contribute/source/plugin/wasmedge_zlib.md Outdated
Comment thread docs/start/wasmedge/extensions/gc.md Outdated
- 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Add documentation pages for plugins available in the docs directory

3 participants