wasmCloud / wasmCloud/wasmcloud.com

Documentation on packaging and publishing WIT packages

Open
#690 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted
Dominant language
MDX
Stars
23
Forks
70
Avg merge
2d 1h
Merged PRs (30d)
17

Description

In our documentation we have information about how to build and publish Wasm components, and with the introduction of wkg I think we should add information about how to build and publish WIT packages (as Wasm).

Additionally, I think we can offer some guidance here as well, e.g. if you're publishing a component other folks are going to compose with over the interface wasmcloud:blobby/foobar, the interface goes to ghcr.io/wasmcloud/wasmcloud/blobby:0.2.0 and the component goes to ghcr.io/wasmcloud/blobby:0.2.0?

cc @thomastaylor312

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 locating the existing documentation on building and publishing Wasm components, then review how wkg handles building and publishing WIT packages. Document the package and component publishing guidance, including the interface and registry naming example described in the issue. Done means the documentation explains both workflows and how their published references relate.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.