SIMD types and instructions aren't documented in the JS API

Open
#4,592 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript, wasm
Domain
documentation

Research direction

Start with the binaryen.js API wiki page and compare its documented types and instructions with the latest Binaryen npm API, focusing on the missing SIMD entries. Review how the existing API documentation is organized, then document all available SIMD types and instructions. Done means users can find the SIMD API without inferring it from other types or instructions.

Written by the indexing model from the issue text.

Description

I'm reading https://github.com/WebAssembly/binaryen/wiki/binaryen.js-API and I noticed literally none of the SIMD types available (available in the latest version on npm) are documented. Could this be resolved so I'm not just making educated guesses based on the existing types and the instructions themselves?

I obviously couldn't do it myself - if I did, I likely wouldn't be filing this issue.

Dominant language
WebAssembly
Stars
8.6k
Forks
885
Avg merge
2d 1h
Merged PRs (30d)
70

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from WebAssembly/binaryen

All issues in WebAssembly/binaryen

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.