bytecodealliance / bytecodealliance/component-docs

Reorganize host and component code

Open
#315 0 comments 2 reactions 0 assignees View on GitHub
enhancement good first issue refactor
Dominant language
Rust
Stars
137
Forks
88
Avg merge
5d 12h
Merged PRs (30d)
4

Description

Now that we're storing code for components and hosts in the repository, we should likely reorganize the code tree of the repository itself.

Some issues:

- We have a python host that should probably be close to the rust host (`example-host` assumes Rust, but we should probably have folders for different langauges)
- Components should be more consistently organized under a scheme like `/`, rather than what we have now (i.e. `python/adder`, `js/adder`, `rust/calculator`, etc)

Contributor guide

Open the contributing guide

Research direction

Start by inventorying the existing host and component directories, including python/adder, js/adder, rust/calculator, and example-host. Decide on and document a consistent language/tutorial layout, then verify that hosts and components are grouped accordingly without losing any examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python, rust, wasm
Domain
documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.