Skip to content

Add more links to the Wasm sidebar #39096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 16, 2025
Merged

Add more links to the Wasm sidebar #39096

merged 6 commits into from
Apr 16, 2025

Conversation

Josh-Cena
Copy link
Member

A lot of pages are not reachable from the sidebar, making the Wasm docs extremely hard to navigate. This adds pretty much everything to the sidebar.

@Josh-Cena Josh-Cena requested a review from a team as a code owner April 12, 2025 18:14
@Josh-Cena Josh-Cena requested review from dipikabh and removed request for a team April 12, 2025 18:14
@github-actions github-actions bot added the size/m [PR only] 51-500 LoC changed label Apr 12, 2025
Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, looks much neater and better organized, not to mention that all pages are now discoverable via sidebar. Thank you!

I've added a few comments, lmk what you think.

@@ -68,6 +142,7 @@ l10n:
en-US:
WebAssembly_concepts: WebAssembly concepts
Compiling_to_Wasm: Compiling from C/C++ to WebAssembly
Existing_C_to_Wasm: Compiling an existing C module to WebAssembly
Compiling_Rust_to_Wasm: Compiling from Rust to WebAssembly
JavaScript_API: Using the WebAssembly JavaScript API
Text_format: Understanding WebAssembly text format
Copy link
Contributor

@dipikabh dipikabh Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need an entry for:

Suggested change
Text_format: Understanding WebAssembly text format
Text_format: Understanding WebAssembly text format
Text_format_to_Wasm: Converting text format to WebAssembly

The page title on https://developer.mozilla.org/en-US/docs/WebAssembly/Guides/Text_format_to_Wasm can also be changed

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you suggesting we should change the page title? The current title doesn't look too bad for me.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I was suggesting we update both the page title as well as the sidebar entry - mainly to replace "Wasm" with "WebAssembly".
This is the only sidebar entry that uses "Wasm" instead of "WebAssembly", and it is pulling this directly from the page title "Converting WebAssembly text format to Wasm"

Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving so you can merge when it's ready. Thanks again!

@Josh-Cena Josh-Cena requested a review from a team as a code owner April 15, 2025 23:36
@Josh-Cena Josh-Cena requested review from chrisdavidmills and removed request for a team April 15, 2025 23:36
@github-actions github-actions bot added the Content:wasm WebAssembly docs label Apr 15, 2025
@Josh-Cena
Copy link
Member Author

How does "Converting WebAssembly text format to binary" look?

Copy link
Contributor

github-actions bot commented Apr 15, 2025

Preview URLs

(comment last updated: 2025-04-16 23:23:50)

@dipikabh
Copy link
Contributor

How does "Converting WebAssembly text format to binary" look?

Good for the page title but long for the sidebar. Can we strip "to binary" for the sidebar title?

@Josh-Cena
Copy link
Member Author

Josh-Cena commented Apr 16, 2025

How about "Converting text format to binary" for the sidebar? The reason is, "Converting WebAssembly text format" is not quite clear.

@Josh-Cena
Copy link
Member Author

After sitting on it some more, I think I prefer your suggestion. Thanks for the reviews!

@Josh-Cena Josh-Cena merged commit 95a7913 into mdn:main Apr 16, 2025
8 checks passed
@Josh-Cena Josh-Cena deleted the wasm-sidebar branch April 16, 2025 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:wasm WebAssembly docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants