Improve accessibility of project/tutorial project templates
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Feature
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- javascript, python, rust, wasm
- Bereich
- developer-experience, documentation, tooling
Rechercherichtung
Beginne mit der Prüfung des Layouts des Repositorys component-docs und des Vorschlags in Issue #219. Vergleiche anschließend die hier beschriebenen Optionen für ein einzelnes Repository auf oberster Ebene, Current-release-Tarballs und sprachspezifisches Scaffolding. Lege einen abgestimmten Setup-Pfad für Tutorial-Ressourcen fest und überprüfe, dass er die genannten Rust-, JavaScript- und Python-Workflows abdeckt, ohne dass Benutzer in ein verschachteltes Unterverzeichnis wechseln müssen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Rust
- Sterne
- 137
- Forks
- 88
- Ø Merge
- 10 Std. 38 Min.
- Gemergte PRs (30 T.)
- 2
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus bytecodealliance/component-docs
-
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 72/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
bytecodealliance/component-docs#294 · 1 Kommentar ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
bytecodealliance/component-docs#376 · 1 Kommentar ·
-
Fix Python Tutorial Offenbug lang/python
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
bytecodealliance/component-docs#348 · 2 Kommentare ·
Alle Issues in bytecodealliance/component-docs
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
-
bug core
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 86/100
-
JIT-compiled number -> Decimal conversion silently overflows instead of raising DECIMAL_OVERFLOW Offenfuzz
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
ClickHouse/ClickHouse#122114 ·
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 92/100
linebender/vello_svg#90 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100