swiftwasm / swiftwasm/WasmKit

Enhance documentation

Open
#71 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Swift
Stars
504
Forks
37
Avg merge
1d 1h
Merged PRs (30d)
44

Description

  • Example of WasmKit engine
  • API document of WasmKit
  • Example and usage of WITOverlayGenerator
  • Example and usage of WITExtractor

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 by reviewing the existing WasmKit engine example and API documentation to follow their structure. Then inspect WITOverlayGenerator and WITExtractor and document an example and usage for each; done means both unchecked items have clear, working documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift, wasm
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.