bytecodealliance / bytecodealliance/component-docs

Improve accessibility of project/tutorial project templates

未关闭
#241 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Rust
星标
137
派生
88
平均合并
5 天 12 小时
30 天内合并 PR
4

描述

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.

贡献指南

打开贡献指南

调研方向

首先查看 component-docs repository 的布局以及 issue #219 中的提案,然后比较这里所述的单一顶层 repository、Current-release tarball 和特定语言 scaffolding 选项。为教程资源确定一条一致同意的设置路径,并验证它涵盖所提到的 Rust、JavaScript 和 Python 工作流,同时不要求用户进入嵌套的子目录。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, python, rust, wasm
领域
developer-experience, documentation, tooling
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。