Tracking: WASI P3 documentation updates

オープン
#341 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
静か
技術スタック
javascript, rust, wasm
領域
documentation

調査の方向性

まず #340 と、そこに記載されている P3 の作業領域(Understanding、WIT reference、WIT by Example、Rust および JavaScript のガイド、running-components の jco ページ、Canonical ABI、FAQ、移行コンテンツ)を読みます。単位を選ぶ前に、どの child issue が利用可能かを確認してください。完了とは、適切なバージョン付きタブ、notice、相互リンクを備えた、レビュー可能な P3 ドキュメント更新を意味します。

索引モデルが issue の本文から書いたものです。

説明

The Component Model book needs to be updated for P3. This issue tracks the overall effort; individual child issues will be filed for each reviewable unit of work below.

The high-level approach is inline tabbed content for sections that differ between P2 and P3. Pages that are version-agnostic stay untouched. A small admonition at the top of each version-variable page signals that tabbed content is present.

Infrastructure landed in #340:

  • mdbook-tabs preprocessor registered with theme-aware tabs.css
  • version-notice.css for the page-level callout
  • /running-components/wasmtime.html converted as the first real demonstration

Remaining work (child issues proposed for filing after discussion):

  • Document WASI P3 async primitives (async func, stream<T>, future<T>) in the Understanding section
  • Update WIT reference and WIT by Example for WASI P3 syntax
  • Convert Rust "Building a simple component" guide for WASI P3
  • Convert JavaScript "Building a simple component" guide for WASI P3
  • Convert jco "Running components" page for WASI P3
  • Add a WASI P2 to P3 migration guide
  • Update the Canonical ABI page with async extensions
  • Update the FAQ with WASI P3 questions
  • Cross-link with WASI.dev for WASI P3 content

Related: #340

主要言語
Rust
スター
137
フォーク
88
平均マージ
10時間 38分
マージ済み PR(30日)
2

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

bytecodealliance/component-docs のほかの issue

bytecodealliance/component-docs の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。