WebAssembly / WebAssembly/wasi-webgpu

Documentation from MDN

Open
#18 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
220
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Dart has taken an interesting approach when it comes to documentation. They scrape MDN's markdown content, convert it into json, and use that for documentation of their JS bindings.

Should we do the same for our docs here? We can probably reuse their same json file.
(Maybe we can even convince them to publish it as a wasm-component)

cc @seanisom

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the linked dart-lang/web tool/scrape_mdn.dart and generated third_party/mdn/mdn.json, then inspect how this repository currently documents its bindings. Determine whether adopting the scraped JSON and possibly publishing it as a wasm component is in scope; done requires a defined approach or implementation boundary.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart, json, wasm
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.