WebAssembly / WebAssembly/WASI

Consider publishing an mdbook

Open
#488 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

S-inactive
Dominant language
Rust
Stars
5.8k
Forks
333
Avg merge
2d 13h
Merged PRs (30d)
3

Description

I believe that using Github files purely for organizing documentation is subpar. I find that most of the Rust books are far superior simply because they organize documentation in terms of mdbooks which are accessible in a separate website. Is it possible to create an mdbook under github.io that organizes the documentation for WASI?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the current WASI documentation organization and the requested mdBook publication under github.io. Define the book's scope, structure, and publishing approach before implementation; done means the documentation is organized as an accessible mdBook website.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.