bytecodealliance / bytecodealliance/component-docs

Improve accessibility of project/tutorial project templates

Abierto
#241 4 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Rust
Estrellas
137
Forks
88
Merge medio
5 d 12 h
PR fusionados (30 d)
4

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza revisando la estructura del repositorio component-docs y la propuesta del issue #219; después, compara las opciones descritas aquí de un único repositorio en el nivel superior, tarballs de Current-release y scaffolding específico por lenguaje. Define una ruta de configuración acordada para los recursos de los tutoriales y verifica que cubra los workflows mencionados de Rust, JavaScript y Python sin requerir que los usuarios naveguen a un subdirectorio anidado.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, python, rust, wasm
Área
developer-experience, documentation, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.