diff --git a/OWNERS b/OWNERS index 43cfcc48b2..1856f307ef 100644 --- a/OWNERS +++ b/OWNERS @@ -8,4 +8,4 @@ kainino@chromium.org per-file dawn.json=kainino@chromium.org per-file DEPS=* -per-file README.md=file://docs/OWNERS +per-file README.md=file://docs/dawn/OWNERS diff --git a/README.md b/README.md index ced36da573..18713889c2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Dawn's logo: a sun rising behind a stylized mountain inspired by the WebGPU logo. The text "Dawn" is written below it.](docs/logo/dawn_logo.png "Dawn's logo") +![Dawn's logo: a sun rising behind a stylized mountain inspired by the WebGPU logo. The text "Dawn" is written below it.](docs/imgs/dawn_logo.png "Dawn's logo") # Dawn, a WebGPU implementation @@ -29,13 +29,13 @@ Helpful links: Developer documentation: - - [Dawn overview](docs/overview.md) - - [Building Dawn](docs/building.md) - - [Contributing to Dawn](docs/contributing.md) - - [Testing Dawn](docs/testing.md) - - [Debugging Dawn](docs/debugging.md) - - [Dawn's infrastructure](docs/infra.md) - - [Dawn errors](docs/errors.md) + - [Dawn overview](docs/dawn/overview.md) + - [Building Dawn](docs/dawn/building.md) + - [Contributing to Dawn](docs/dawn/contributing.md) + - [Testing Dawn](docs/dawn/testing.md) + - [Debugging Dawn](docs/dawn/debugging.md) + - [Dawn's infrastructure](docs/dawn/infra.md) + - [Dawn errors](docs/dawn/errors.md) User documentation: (TODO, figure out what overlaps with the webgpu.h docs) diff --git a/dawn.json b/dawn.json index ec441faf26..c18b3c3e60 100644 --- a/dawn.json +++ b/dawn.json @@ -15,7 +15,7 @@ "limitations under the License." ], - "_doc": "See docs/codegen.md", + "_doc": "See docs/dawn/codegen.md", "_metadata": { "api": "WebGPU", diff --git a/dawn_wire.json b/dawn_wire.json index 869f74bafd..226321e701 100644 --- a/dawn_wire.json +++ b/dawn_wire.json @@ -15,7 +15,7 @@ "limitations under the License." ], - "_doc": "See docs/codegen.md", + "_doc": "See docs/dawn/codegen.md", "commands": { "buffer map async": [ diff --git a/docs/OWNERS b/docs/dawn/OWNERS similarity index 100% rename from docs/OWNERS rename to docs/dawn/OWNERS diff --git a/docs/buffer_mapping.md b/docs/dawn/buffer_mapping.md similarity index 100% rename from docs/buffer_mapping.md rename to docs/dawn/buffer_mapping.md diff --git a/docs/building.md b/docs/dawn/building.md similarity index 100% rename from docs/building.md rename to docs/dawn/building.md diff --git a/docs/codegen.md b/docs/dawn/codegen.md similarity index 100% rename from docs/codegen.md rename to docs/dawn/codegen.md diff --git a/docs/contributing.md b/docs/dawn/contributing.md similarity index 100% rename from docs/contributing.md rename to docs/dawn/contributing.md diff --git a/docs/debug_markers.md b/docs/dawn/debug_markers.md similarity index 100% rename from docs/debug_markers.md rename to docs/dawn/debug_markers.md diff --git a/docs/debugging.md b/docs/dawn/debugging.md similarity index 100% rename from docs/debugging.md rename to docs/dawn/debugging.md diff --git a/docs/device_facilities.md b/docs/dawn/device_facilities.md similarity index 100% rename from docs/device_facilities.md rename to docs/dawn/device_facilities.md diff --git a/docs/errors.md b/docs/dawn/errors.md similarity index 100% rename from docs/errors.md rename to docs/dawn/errors.md diff --git a/docs/external_resources.md b/docs/dawn/external_resources.md similarity index 100% rename from docs/external_resources.md rename to docs/dawn/external_resources.md diff --git a/docs/features/dawn_internal_usages.md b/docs/dawn/features/dawn_internal_usages.md similarity index 100% rename from docs/features/dawn_internal_usages.md rename to docs/dawn/features/dawn_internal_usages.md diff --git a/docs/features/dawn_native.md b/docs/dawn/features/dawn_native.md similarity index 100% rename from docs/features/dawn_native.md rename to docs/dawn/features/dawn_native.md diff --git a/docs/fuzzing.md b/docs/dawn/fuzzing.md similarity index 100% rename from docs/fuzzing.md rename to docs/dawn/fuzzing.md diff --git a/docs/infra.md b/docs/dawn/infra.md similarity index 100% rename from docs/infra.md rename to docs/dawn/infra.md diff --git a/docs/overview.md b/docs/dawn/overview.md similarity index 100% rename from docs/overview.md rename to docs/dawn/overview.md diff --git a/docs/testing.md b/docs/dawn/testing.md similarity index 100% rename from docs/testing.md rename to docs/dawn/testing.md diff --git a/docs/logo/README.md b/docs/imgs/README.md similarity index 100% rename from docs/logo/README.md rename to docs/imgs/README.md diff --git a/docs/logo/dawn_logo.png b/docs/imgs/dawn_logo.png similarity index 100% rename from docs/logo/dawn_logo.png rename to docs/imgs/dawn_logo.png diff --git a/docs/logo/dawn_logo.svg b/docs/imgs/dawn_logo.svg similarity index 100% rename from docs/logo/dawn_logo.svg rename to docs/imgs/dawn_logo.svg diff --git a/docs/logo/dawn_logo_black.png b/docs/imgs/dawn_logo_black.png similarity index 100% rename from docs/logo/dawn_logo_black.png rename to docs/imgs/dawn_logo_black.png diff --git a/docs/logo/dawn_logo_black.svg b/docs/imgs/dawn_logo_black.svg similarity index 100% rename from docs/logo/dawn_logo_black.svg rename to docs/imgs/dawn_logo_black.svg diff --git a/docs/logo/dawn_logo_black_notext.png b/docs/imgs/dawn_logo_black_notext.png similarity index 100% rename from docs/logo/dawn_logo_black_notext.png rename to docs/imgs/dawn_logo_black_notext.png diff --git a/docs/logo/dawn_logo_black_notext.svg b/docs/imgs/dawn_logo_black_notext.svg similarity index 100% rename from docs/logo/dawn_logo_black_notext.svg rename to docs/imgs/dawn_logo_black_notext.svg diff --git a/docs/logo/dawn_logo_notext.png b/docs/imgs/dawn_logo_notext.png similarity index 100% rename from docs/logo/dawn_logo_notext.png rename to docs/imgs/dawn_logo_notext.png diff --git a/docs/logo/dawn_logo_notext.svg b/docs/imgs/dawn_logo_notext.svg similarity index 100% rename from docs/logo/dawn_logo_notext.svg rename to docs/imgs/dawn_logo_notext.svg diff --git a/docs/logo/dawn_logo_white.png b/docs/imgs/dawn_logo_white.png similarity index 100% rename from docs/logo/dawn_logo_white.png rename to docs/imgs/dawn_logo_white.png diff --git a/docs/logo/dawn_logo_white.svg b/docs/imgs/dawn_logo_white.svg similarity index 100% rename from docs/logo/dawn_logo_white.svg rename to docs/imgs/dawn_logo_white.svg diff --git a/docs/logo/dawn_logo_white_notext.png b/docs/imgs/dawn_logo_white_notext.png similarity index 100% rename from docs/logo/dawn_logo_white_notext.png rename to docs/imgs/dawn_logo_white_notext.png diff --git a/docs/logo/dawn_logo_white_notext.svg b/docs/imgs/dawn_logo_white_notext.svg similarity index 100% rename from docs/logo/dawn_logo_white_notext.svg rename to docs/imgs/dawn_logo_white_notext.svg diff --git a/src/dawn_native/Features.cpp b/src/dawn_native/Features.cpp index 0d98b4e4ad..81d9bedd2c 100644 --- a/src/dawn_native/Features.cpp +++ b/src/dawn_native/Features.cpp @@ -76,7 +76,7 @@ namespace dawn::native { {"dawn-internal-usages", "Add internal usages to resources to affect how the texture is allocated, but not " "frontend validation. Other internal commands may access this usage.", - "https://dawn.googlesource.com/dawn/+/refs/heads/main/docs/features/" + "https://dawn.googlesource.com/dawn/+/refs/heads/main/docs/dawn/features/" "dawn_internal_usages.md"}, &WGPUDeviceProperties::dawnInternalUsages}, {Feature::MultiPlanarFormats, @@ -86,7 +86,7 @@ namespace dawn::native { &WGPUDeviceProperties::multiPlanarFormats}, {Feature::DawnNative, {"dawn-native", "WebGPU is running on top of dawn_native.", - "https://dawn.googlesource.com/dawn/+/refs/heads/main/docs/features/" + "https://dawn.googlesource.com/dawn/+/refs/heads/main/docs/dawn/features/" "dawn_native.md"}, &WGPUDeviceProperties::dawnNative}}}; diff --git a/src/dawn_node/README.md b/src/dawn_node/README.md index 58c9297c34..d9b1f68ba3 100644 --- a/src/dawn_node/README.md +++ b/src/dawn_node/README.md @@ -17,7 +17,7 @@ Dawn uses the Chromium build system and dependency management so you need to [in ### Fetch dependencies -First, the steps are similar to [`doc/building.md`](../../docs/building.md), but instead of the `Get the code` step, run: +First, the steps are similar to [`doc/building.md`](../../docs/dawn/building.md), but instead of the `Get the code` step, run: ```sh # Clone the repo as "dawn" diff --git a/src/tests/perf_tests/README.md b/src/tests/perf_tests/README.md index 3e16b1c65b..5c419edda5 100644 --- a/src/tests/perf_tests/README.md +++ b/src/tests/perf_tests/README.md @@ -1,2 +1,2 @@ # Dawn Perf Tests -Moved to [`//src/docs/testing.md`](https://dawn.googlesource.com/dawn/+/refs/heads/main/docs/testing.md). +Moved to [`//src/docs/dawn/testing.md`](https://dawn.googlesource.com/dawn/+/refs/heads/main/docs/dawn/testing.md).