WebGPU PR #3 — Interfaces for representing pipelines by chrisdavidmills · Pull Request #25174 · mdn/content

chrisdavidmills · 2023-03-08T11:55:24Z

Important: DO NOT merge this PR until #25140 has been merged.

Description

This PR is part of a multi-PR series that aims to document the WebGPU API. The interfaces documented in this PR are:

GPUBindGroup (done)
GPUBindGroupLayout (done)
GPUComputePipeline (done)
GPUPipelineLayout (done)
GPURenderPipeline (done)

Note that the main PR for this series is #24202 — that one must be merged first, before any others! after that, and each subsequent one, is merged, main should be merged into the next PR, and the documentation integrity must be checked (e.g. do all the links work) before merging.

You can see full details of the additions expected in the WebGPU docs in my research document.

Motivation

Additional details

Related issues and pull requests

github-actions · 2023-03-08T11:57:33Z

Preview URLs (12 pages)

Flaws (15)

URL: /en-US/docs/Web/API/GPUBindGroupLayout
Title: GPUBindGroupLayout
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUBindGroupLayout/label
Title: GPUBindGroupLayout.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUBindGroup
Title: GPUBindGroup
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUBindGroup/label
Title: GPUBindGroup.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUComputePipeline
Title: GPUComputePipeline
Flaw count: 2

macros:
- /en-US/docs/Web/API/GPUComputePassEncoder does not exist
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUComputePipeline/label
Title: GPUComputePipeline.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUComputePipeline/getBindGroupLayout
Title: GPUComputePipeline.getBindGroupLayout()
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUValidationError does not exist

URL: /en-US/docs/Web/API/GPUPipelineLayout
Title: GPUPipelineLayout
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPUPipelineLayout/label
Title: GPUPipelineLayout.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPURenderPipeline
Title: GPURenderPipeline
Flaw count: 3

macros:
- /en-US/docs/Web/API/GPURenderPassEncoder does not exist
- /en-US/docs/Web/API/GPURenderBundleEncoder does not exist
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPURenderPipeline/label
Title: GPURenderPipeline.label
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUError does not exist

URL: /en-US/docs/Web/API/GPURenderPipeline/getBindGroupLayout
Title: GPURenderPipeline.getBindGroupLayout()
Flaw count: 1

macros:
- /en-US/docs/Web/API/GPUValidationError does not exist

External URLs (11)

URL: /en-US/docs/Web/API/GPUBindGroupLayout
Title: GPUBindGroupLayout

https://mdn.github.io/dom-examples/webgpu-compute-demo/ (1 time) (Note! This may be a new URL 👀)
https://webgpu.github.io/webgpu-samples/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUBindGroup
Title: GPUBindGroup

https://mdn.github.io/dom-examples/webgpu-compute-demo/ (1 time) (Note! This may be a new URL 👀)
https://webgpu.github.io/webgpu-samples/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUComputePipeline
Title: GPUComputePipeline

https://mdn.github.io/dom-examples/webgpu-compute-demo/ (1 time) (Note! This may be a new URL 👀)
https://webgpu.github.io/webgpu-samples/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUComputePipeline/getBindGroupLayout
Title: GPUComputePipeline.getBindGroupLayout()

https://webgpu.github.io/webgpu-samples/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPUPipelineLayout
Title: GPUPipelineLayout

https://webgpu.github.io/webgpu-samples/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPURenderPipeline
Title: GPURenderPipeline

https://mdn.github.io/dom-examples/webgpu-render-demo/ (1 time) (Note! This may be a new URL 👀)
https://webgpu.github.io/webgpu-samples/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/API/GPURenderPipeline/getBindGroupLayout
Title: GPURenderPipeline.getBindGroupLayout()

https://webgpu.github.io/webgpu-samples/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2023-04-05 13:00:28)

chrisdavidmills · 2023-03-08T15:26:18Z

@toji Another set of WebGPU docs to review! A much smaller one this time round.

toji

Great work, as always! Not too much feedback this time around.

files/en-us/web/api/gpucomputepipeline/getbindgrouplayout/index.md

files/en-us/web/api/gpurenderpipeline/getbindgrouplayout/index.md

chrisdavidmills · 2023-03-13T08:29:50Z

@toji OK, fixes made. Thanks for the comments!

toji

Great! Updated PR LGTM overall. Can't approve because it's a draft.

chrisdavidmills · 2023-03-20T08:03:10Z

Great! Updated PR LGTM overall. Can't approve because it's a draft.

Thanks! I'll keep a note in the main PR about which ones you've reviewed and given the thumbs up to. I'm keeping them as drafts for now just in case some random community member decides to try to merge it. I'll undraft them once the content is all done and we are ready to merge.

Elchi3

Merging as discussed in slack! 👍

chrisdavidmills requested a review from a team as a code owner March 8, 2023 11:55

chrisdavidmills requested review from wbamberg and removed request for a team March 8, 2023 11:55

github-actions bot added the Content:WebAPI Web API docs label Mar 8, 2023

chrisdavidmills changed the title ~~Add reference docs for GPUBindGroup~~ WebGPU PR #3 — Interfaces for representing pipelines Mar 8, 2023

chrisdavidmills mentioned this pull request Mar 8, 2023

WebGPU API docs #24202

Merged

chrisdavidmills marked this pull request as draft March 8, 2023 11:56

toji reviewed Mar 8, 2023

View reviewed changes

toji reviewed Mar 16, 2023

View reviewed changes

chrisdavidmills marked this pull request as ready for review April 3, 2023 08:54

chrisdavidmills mentioned this pull request Apr 3, 2023

WebGPU PR #4 — Interfaces for handling errors and queries #25184

Merged

chrisdavidmills added 7 commits April 5, 2023 13:57

Add reference docs for GPUBindGroup

0c270c0

Add reference docs for GPUBindGroupLayout

f19ea94

Add reference docs for GPUPipelineLayout

9831664

Add reference docs for GPUComputePipeline and GPURenderPipeline

1dea081

Making fixes for toji comments

9d5407b

fix typo

c1885bb

Update basic MDN demo example links to point to dom-examples versions

29b4fb5

chrisdavidmills force-pushed the webgpu-docs-3-pipelines branch from 1056b69 to 29b4fb5 Compare April 5, 2023 12:58

Elchi3 approved these changes Apr 5, 2023

View reviewed changes

Elchi3 merged commit f53f079 into mdn:main Apr 5, 2023

chrisdavidmills deleted the webgpu-docs-3-pipelines branch April 5, 2023 13:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

WebGPU PR #3 — Interfaces for representing pipelines#25174

WebGPU PR #3 — Interfaces for representing pipelines#25174
Elchi3 merged 7 commits intomdn:mainfrom
chrisdavidmills:webgpu-docs-3-pipelines

chrisdavidmills commented Mar 8, 2023 •

edited

Loading

Uh oh!

github-actions bot commented Mar 8, 2023 •

edited

Loading

Uh oh!

chrisdavidmills commented Mar 8, 2023

Uh oh!

toji left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrisdavidmills commented Mar 13, 2023

Uh oh!

toji left a comment

Uh oh!

chrisdavidmills commented Mar 20, 2023

Uh oh!

Elchi3 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

chrisdavidmills commented Mar 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation

Additional details

Related issues and pull requests

Uh oh!

github-actions bot commented Mar 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chrisdavidmills commented Mar 8, 2023

Uh oh!

toji left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrisdavidmills commented Mar 13, 2023

Uh oh!

toji left a comment

Choose a reason for hiding this comment

Uh oh!

chrisdavidmills commented Mar 20, 2023

Uh oh!

Elchi3 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chrisdavidmills commented Mar 8, 2023 •

edited

Loading

github-actions bot commented Mar 8, 2023 •

edited

Loading