Tracking: WASI P3 documentation updates
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- javascript, rust, wasm
- Domain
- documentation
Research direction
Start by reading #340 and the listed P3 work areas: Understanding, WIT reference, WIT by Example, the Rust and JavaScript guides, the jco running-components page, Canonical ABI, FAQ, and migration content. Confirm which child issue is available before choosing a unit; done means a reviewable P3 documentation update with the appropriate versioned tabs, notice, and cross-links.
Written by the indexing model from the issue text.
Description
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-tabspreprocessor registered with theme-awaretabs.cssversion-notice.cssfor the page-level callout/running-components/wasmtime.htmlconverted 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
- Dominant language
- Rust
- Stars
- 137
- Forks
- 88
- Avg merge
- 10h 38m
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bytecodealliance/component-docs
-
Difficulty 2/5 Half a day Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
bytecodealliance/component-docs#294 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
bytecodealliance/component-docs#376 · 1 comment ·
-
Fix Python Tutorial Openbug lang/python
Difficulty 3/5 1-2 days Newbie friendliness 55/100
bytecodealliance/component-docs#348 · 2 comments ·
All issues in bytecodealliance/component-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
state:needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
zed-industries/zed#64680 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
RustPython/RustPython#8802 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
TheLarkInn/aipm#2390 ·