Skip to content

Add introduction sections to JS API and Web API documents - #1814

Merged
dschuff merged 3 commits into
WebAssembly:mainfrom
dschuff:intros
Sep 30, 2024
Merged

Add introduction sections to JS API and Web API documents#1814
dschuff merged 3 commits into
WebAssembly:mainfrom
dschuff:intros

Conversation

@dschuff

@dschuff dschuff commented Sep 27, 2024

Copy link
Copy Markdown
Member

These sections provide a bit more background about their relationship to the layer beneath them.
They also solve the problem that the existing minimal introductory text was hidden in the
bottom of the "status of this document" section.

@dschuff
dschuff requested review from Ms2ger and rossberg September 27, 2024 18:50

@rossberg rossberg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like it.

Comment thread document/js-api/index.bs Outdated
Comment thread document/js-api/index.bs Outdated
with their surrounding execution environment. Instead it defines an abstract [=embedding interface=] between WebAssembly and its environment,
(called the *embedder*). It is only through this interface that an embedder interacts with the semantics of WebAssembly, and the embedder
implements the connection between its host environment and the embedding API.
This document describes the embedding of WebAssembly into JavaScript [[ECMASCRIPT]] environments, including how WebAssembly modules

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I noted that ECMASCRIPT isn't actually listed in the biblio section above. Is that somehow automatic?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

yes: https://github.com/speced/bikeshed-data/blob/main/data/biblio/biblio-ec.data#L31 (there's probably an easier place to look than these raw files but I'm not sure where it is :)

Comment thread document/web-api/index.bs Outdated

@Ms2ger Ms2ger left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks!

Comment thread document/js-api/index.bs Outdated
Comment thread document/js-api/index.bs Outdated
@dschuff
dschuff merged commit a700617 into WebAssembly:main Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants