WebAssembly / WebAssembly/website

Does the spec make the older docs redundant?

Open
#148 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
287
Forks
212
Avg merge
13h 36m
Merged PRs (30d)
7

Description

Having briefly discussed some problems with docs/design/Modules.md with @lukewagner (#147), he suggested just deleting the doc as it's old, unmaintained and incorrect in many places. I asked for it to stay up, as there isn't much information at that level of detail currently (it's all either intros or specs).

Luke helped me with my problem, and suggested editing Modules.md to improve it, which I was happy to do, but I'm totally new to WASM, and the doc is far more out of date than I realized, so I'm not confident that what I've written is current and correct.

I'll attach my version of Modules.md, in case anyone wants to help with it:
Modules.txt

More generally, there's a lack of detailed information about WAT and WASM (other than the spec). I'd be happy to contribute to the documentation once I understand things better myself, but if the old docs have been abandoned in favor of the spec, are there any official docs to contribute to any more?

I'm happy to publish unofficial stuff on my own initiative, but wondered what the policy is. Is there a commitment to maintaining official documentation (other than the spec) now?

Contributor guide

No contributing guide indexed for this repository

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

Start by reading docs/design/Modules.md, the attached Modules.txt, and the discussion in issue #147. Determine whether the older document should be deleted or maintained, and identify the official documentation policy for detailed WAT and WASM material. Done means a clear project decision and an agreed path for maintaining or replacing the document.

Written by the indexing model from the issue text.

Assessment

Tech stack
wasm
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.