bytecodealliance / bytecodealliance/component-docs

Improve accessibility of project/tutorial project templates

Đang mở
#241 4 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Rust
Star
137
Fork
88
Merge trung bình
5 ngày 12 giờ
Pull request đã merge (30 ngày)
4

Mô tả

Currently, new users must clone the `component-docs` repo, head to a specific sub-directory *then* attempt to build projects.

It would be ideal if there were easier ways to download and set up resources to walk through the tutorials.

While we probably want to *avoid* building custom tooling in every possible language (different languages have different scaffolding mechanisms), we need a solution that is a bit less nested.

There were several good suggestions made, one of which being a single repo that contains all the languages at the top level (thanks @mkatychev), which is a bit easier to clone and filter out.

Another suggestion is that this could actually be a part of #219 -- having a "Current" release that always contains tarballs of the current code for any given language might make it easy to download and extract (ex. `rust-starter.zip` or `js-starter.zip`).

We could also rely on language-specific templating functionality, but this would likely require ensuring that it *exists in the first place* for all related languages (i.e. `cargo component new`, `jco new`, `componetize-py new`, etc), or in a shared tool like `wit-bindgen` which may not be feasible.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Start by reviewing the component-docs repository layout and the proposal in issue #219, then compare the single top-level repository, Current-release tarballs, and language-specific scaffolding options described here. Define one agreed setup path for tutorial resources and verify that it covers the mentioned Rust, JavaScript, and Python workflows without requiring users to navigate a nested subdirectory.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript, python, rust, wasm
Lĩnh vực
developer-experience, documentation, tooling
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.