From 111425b789f0cc112f0197fc9e5fd23de8a864c4 Mon Sep 17 00:00:00 2001 From: Connor Fitzgerald Date: Sun, 23 Feb 2025 03:43:17 -0500 Subject: [PATCH] Refactor Documentation into a `docs` folder (#7202) --- README.md | 6 +++--- {etc/specs => docs/api-specs}/ray_tracing.md | 0 {etc => docs}/big-picture.png | Bin {etc => docs}/big-picture.xml | 0 RELEASE.md => docs/release-checklist.md | 0 {etc => docs}/render_coordinates.png | Bin REVIEW-CHECKLIST.md => docs/review-checklist.md | 0 {etc => docs}/texture_coordinates.png | Bin typos.toml | 2 +- 9 files changed, 4 insertions(+), 4 deletions(-) rename {etc/specs => docs/api-specs}/ray_tracing.md (100%) rename {etc => docs}/big-picture.png (100%) rename {etc => docs}/big-picture.xml (100%) rename RELEASE.md => docs/release-checklist.md (100%) rename {etc => docs}/render_coordinates.png (100%) rename REVIEW-CHECKLIST.md => docs/review-checklist.md (100%) rename {etc => docs}/texture_coordinates.png (100%) diff --git a/README.md b/README.md index fd22d4160..3e208c869 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The following binaries: - `cts_runner` - WebGPU Conformance Test Suite runner using `deno_webgpu`. - `player` - standalone application for replaying the API traces. -For an overview of all the components in the gfx-rs ecosystem, see [the big picture](./etc/big-picture.png). +For an overview of all the components in the gfx-rs ecosystem, see [the big picture](./docs/big-picture.png). ## Getting Started @@ -86,7 +86,7 @@ For high-level documentation on how to use these extensions, see the individual 🧪EXPERIMENTAL🧪 APIs are subject to change and may allow undefined behavior if used incorrectly. -- 🧪EXPERIMENTAL🧪 [Ray Tracing](./etc/specs/ray_tracing.md). +- 🧪EXPERIMENTAL🧪 [Ray Tracing](./docs/api-specs/ray_tracing.md). ## Supported Platforms @@ -263,4 +263,4 @@ wgpu uses the coordinate systems of D3D and Metal: | Render | Texture | | --------------------------------------------------- | ----------------------------------------------------- | -| ![render_coordinates](./etc/render_coordinates.png) | ![texture_coordinates](./etc/texture_coordinates.png) | +| ![render_coordinates](./docs/render_coordinates.png) | ![texture_coordinates](./docs/texture_coordinates.png) | diff --git a/etc/specs/ray_tracing.md b/docs/api-specs/ray_tracing.md similarity index 100% rename from etc/specs/ray_tracing.md rename to docs/api-specs/ray_tracing.md diff --git a/etc/big-picture.png b/docs/big-picture.png similarity index 100% rename from etc/big-picture.png rename to docs/big-picture.png diff --git a/etc/big-picture.xml b/docs/big-picture.xml similarity index 100% rename from etc/big-picture.xml rename to docs/big-picture.xml diff --git a/RELEASE.md b/docs/release-checklist.md similarity index 100% rename from RELEASE.md rename to docs/release-checklist.md diff --git a/etc/render_coordinates.png b/docs/render_coordinates.png similarity index 100% rename from etc/render_coordinates.png rename to docs/render_coordinates.png diff --git a/REVIEW-CHECKLIST.md b/docs/review-checklist.md similarity index 100% rename from REVIEW-CHECKLIST.md rename to docs/review-checklist.md diff --git a/etc/texture_coordinates.png b/docs/texture_coordinates.png similarity index 100% rename from etc/texture_coordinates.png rename to docs/texture_coordinates.png diff --git a/typos.toml b/typos.toml index 50d30891a..f79b12d19 100644 --- a/typos.toml +++ b/typos.toml @@ -5,7 +5,7 @@ extend-exclude = [ '/.git', # spirv-asm isn't real source code '*.spvasm', - 'etc/big-picture.xml', + 'docs/big-picture.xml', ] # Corrections take the form of a key/value pair. The key is the incorrect word