Group WebAssembly docs into Guides and Reference #37899

pepelsbey · 2025-01-31T13:10:36Z

Moves pages into guides and reference folders

- webassembly/c_to_wasm
+ webassembly/guides/c_to_wasm
- webassembly/javascript_interface
+ webassembly/reference/javascript_interface
etc.

Creates landing pages for guides and references

+ webassembly/reference/index.md
+ webassembly/guides/index.md

Uses front-matter sidebar

+ sidebar: webassemblysidebar
- {{WebAssemblySidebar}}

Uses new page type

+ page-type: listing-page

Motivation

Docs IA & maintenance

TODO

Check links in BCD
Fix links in web-features

github-actions · 2025-01-31T13:12:11Z

Preview URLs (135 pages)

Flaws (4)

Note! 132 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Mozilla/Firefox/Releases/62
Title: Firefox 62 for developers
Flaw count: 2

broken_links:
- Can't resolve /en-US/docs/Web/WebDriver/WebElement
macros:
- Macro produces link /en-US/docs/Web/HTTP/Headers/Content-Security-Policy/referrer which is a redirect

URL: /en-US/docs/Mozilla/Firefox/Releases/100
Title: Firefox 100 for developers
Flaw count: 1

macros:
- Can't resolve /en-US/docs/Web/HTTP/Headers/Large-Allocation

URL: /en-US/docs/Web/HTTP/Headers/Content-Security-Policy
Title: Content-Security-Policy (CSP)
Flaw count: 1

unknown:
- No generic content config found

External URLs (25)

URL: /en-US/docs/WebAssembly/Guides/Using_the_JavaScript_API
Title: Using the WebAssembly JavaScript API

https://github.com/WebAssembly/tool-conventions/blob/main/DynamicLinking.md (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Guides/Concepts
Title: WebAssembly concepts

https://emscripten.org/ (3 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Guides/Understanding_the_text_format
Title: Understanding WebAssembly text format

https://mdn.github.io/webassembly-examples/understanding-text-format/add.html (1 time) (Note! This may be a new URL 👀)
https://webassembly.github.io/spec/core/binary/modules.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/compile_static
Title: WebAssembly.compile()

https://mdn.github.io/webassembly-examples/js-builtin-examples/compile/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/Table
Title: WebAssembly.Table

https://mdn.github.io/webassembly-examples/js-api-examples/table2.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/Table/get
Title: WebAssembly.Table.prototype.get()

https://mdn.github.io/webassembly-examples/js-api-examples/table.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/Table/set
Title: WebAssembly.Table.prototype.set()

https://mdn.github.io/webassembly-examples/js-api-examples/table2.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/Memory
Title: WebAssembly.Memory

https://mdn.github.io/webassembly-examples/js-api-examples/memory.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/Memory/Memory
Title: WebAssembly.Memory() constructor

https://mdn.github.io/webassembly-examples/js-api-examples/memory.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/Memory/buffer
Title: WebAssembly.Memory.prototype.buffer

https://mdn.github.io/webassembly-examples/js-api-examples/memory.html (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/Module/Module
Title: WebAssembly.Module() constructor

https://mdn.github.io/webassembly-examples/js-builtin-examples/module-constructor/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/WebAssembly/Reference/JavaScript_interface/compileStreaming_static
Title: WebAssembly.compileStreaming()

https://mdn.github.io/webassembly-examples/js-api-examples/compile-streaming.html (1 time) (Note! This may be a new URL 👀)
https://mdn.github.io/webassembly-examples/js-builtin-examples/compile-streaming/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/58
Title: Firefox 58 for developers

https://bugzil.la/1277562 (1 time) (Note! This may be a new URL 👀)
https://bugzil.la/1347644 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/62
Title: Firefox 62 for developers

https://bugzil.la/1464656 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/79
Title: Firefox 79 for developers

https://bugzil.la/1389458 (1 time) (Note! This may be a new URL 👀)
https://bugzil.la/1528294 (1 time) (Note! This may be a new URL 👀)
https://bugzil.la/1637884 (1 time) (Note! This may be a new URL 👀)
https://bugzil.la/1648685 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/100
Title: Firefox 100 for developers

https://bugzil.la/1759217 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/64
Title: Firefox 64 for developers

https://bugzil.la/1490286 (1 time) (Note! This may be a new URL 👀)
https://webassembly.github.io/spec/js-api/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/131
Title: Firefox 131 for developers

https://bugzil.la/1908375 (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2025-01-31 14:20:48)

files/sidebars/webassemblysidebar.yaml

bsmth

I had a look through everything, so leaving a +1 with the same comment for front-matter v macro usage, and a comment about the sidebar yml.

pepelsbey added 3 commits January 31, 2025 13:18

Update listings

3fb3b56

Use front-matter sidebar

0842122

Move to Guides/Reference, update links

c7ed55d

github-actions bot added the Content:wasm WebAssembly docs label Jan 31, 2025

pepelsbey requested a review from bsmth January 31, 2025 13:11

github-actions bot added the size/m [PR only] 51-500 LoC changed label Jan 31, 2025

github-actions bot added Content:WebAPI Web API docs Content:JS JavaScript docs Content:HTTP HTTP docs Content:Firefox Content in the Mozilla/Firefox subtree Content:Meta Content in the meta docs labels Jan 31, 2025

pepelsbey marked this pull request as ready for review January 31, 2025 13:14

pepelsbey requested review from a team as code owners January 31, 2025 13:14

pepelsbey requested review from Josh-Cena and removed request for a team January 31, 2025 13:14

github-actions bot added size/xl [PR only] >1000 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Jan 31, 2025

Format wikihistory with Prettier

4f1a257

sideshowbarker removed request for a team January 31, 2025 13:23

bsmth reviewed Jan 31, 2025

View reviewed changes

files/sidebars/webassemblysidebar.yaml Show resolved Hide resolved

bsmth approved these changes Jan 31, 2025

View reviewed changes

pepelsbey removed request for a team and Josh-Cena January 31, 2025 14:16

pepelsbey and others added 2 commits January 31, 2025 15:18

Improve wording for sidebar

53e2c10

Merge branch 'main' into move/webassembly

022533d

Rumyra approved these changes Jan 31, 2025

View reviewed changes

pepelsbey merged commit df9d064 into mdn:main Jan 31, 2025
9 checks passed

pepelsbey deleted the move/webassembly branch January 31, 2025 14:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Group WebAssembly docs into Guides and Reference #37899

Group WebAssembly docs into Guides and Reference #37899

pepelsbey commented Jan 31, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

bsmth left a comment

Group WebAssembly docs into Guides and Reference #37899

Group WebAssembly docs into Guides and Reference #37899

Conversation

pepelsbey commented Jan 31, 2025 • edited Loading

Moves pages into guides and reference folders

Creates landing pages for guides and references

Uses front-matter sidebar

Uses new page type

Motivation

TODO

github-actions bot commented Jan 31, 2025 • edited Loading

bsmth left a comment

Choose a reason for hiding this comment

pepelsbey commented Jan 31, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading