spec
spec copied to clipboard
Can we simplify doc navigation?
I see some problems with the instruction summary table.
-
If you Ctrl+F and look for, say, "call_indirect", there is no text highlighting. The screen may scroll appropriately, but you can't easily find what you're looking for. Probably just a simple CSS or font fix.
-
If you then click on "call_indirect", it brings you to a page about the more generic concept of control transfers. That's like clicking "zebra" and being redirected to an article about zoos.
-
If you actually type "call_indirect" into the search dialog into the left pane, then click "Go", you'll end up with nothing at all (or sometimes a search-engine-style dump of vaguely relevant pages). (This might be more acceptable if the previous point were addressed.)
Navigating the docs, and instruction definitions in particular, should be trivial. Even an unweildy 1000-page PDF would be superior to the current state of affairs.
That's all I have to say about this. The team knows what best to do about it.
Here's the PDF: https://webassembly.github.io/spec/core/_download/WebAssembly.pdf. You may also prefer the bikeshed version: https://webassembly.github.io/spec/core/bikeshed/.
(These are both listed on https://webassembly.github.io/spec/)