Some tweaks to docs

oisyn · oisyn · commit ecceedab92d6 · 2022-12-20T10:43:57.000-08:00
diff --git a/crates/rustc_codegen_spirv-types/Cargo.toml b/crates/rustc_codegen_spirv-types/Cargo.toml
@@ -1,7 +1,6 @@
 [package]
 name = "rustc_codegen_spirv-types"
 description = "SPIR-V backend types shared between rustc_codegen_spirv and spirv-builder"
-documentation = "https://embarkstudios.github.io/rust-gpu/api/rustc_codegen_spirv_types/index.html"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
diff --git a/crates/rustc_codegen_spirv-types/README.md b/crates/rustc_codegen_spirv-types/README.md
@@ -1,3 +1,3 @@
 # `rustc_codegen_spirv-types`
 
-SPIR-V backend types shared between `rustc_codegen_spirv` and `spirv-builder`. Please refer to [`spirv-builder`](https://crates.io/crates/spirv-builder) for more information.
+SPIR-V backend types shared between `rustc_codegen_spirv` and `spirv-builder`. Please refer to [`spirv-builder`](https://docs.rs/spirv-builder/) for more information.
diff --git a/crates/rustc_codegen_spirv-types/src/lib.rs b/crates/rustc_codegen_spirv-types/src/lib.rs
@@ -1,4 +1,4 @@
-//! Types used by both `rustc_codegen_spirv` and `spirv-builder`.
+#![doc = include_str!("../README.md")]
 
 pub use rspirv::spirv::Capability;
 
diff --git a/crates/rustc_codegen_spirv/README.md b/crates/rustc_codegen_spirv/README.md
@@ -1,6 +1,6 @@
 # `rustc_codegen_spirv`
 
-Compiler backend for the `SPIR-V` target architecture. This crate is not intended to be used directly. Please refer to [`spirv-builder`](https://crates.io/crates/spirv-builder) for more information.
+Compiler backend for the `SPIR-V` target architecture. This crate is not intended to be used directly. Please refer to [`spirv-builder`](https://docs.rs/spirv-builder/) for more information.
 
 ## Documentation
 
diff --git a/crates/spirv-builder/README.md b/crates/spirv-builder/README.md
@@ -2,7 +2,7 @@
 <!-- markdownlint-disable-file MD033 -->
 # `spirv-builder`
 
-![Rust version](https://img.shields.io/badge/rust-1.66.0_nightly--2022--10--29-purple.svg)
+![Rust version](https://img.shields.io/badge/rust-nightly--2022--10--29-purple.svg)
 
 This crate gives you `SpirvBuilder`, a tool to build shaders using [rust-gpu][rustgpu].
 
@@ -36,7 +36,7 @@ Because of its nature, `rustc_codegen_spirv`, and therefore `spirv-builder` by e
 Toolchains for previous versions of `spirv-builder`:
 
 |Version|Toolchain|
-|-|-|
+|-:|-|
 |`0.4.0`|`nightly-2022-10-29`|
 |`0.4.0-alpha.16` - `0.4.0-alpha.17`|`nightly-2022-10-01`|
 |`0.4.0-alpha.15`|`nightly-2022-08-29`|
diff --git a/crates/spirv-builder/src/lib.rs b/crates/spirv-builder/src/lib.rs
@@ -69,6 +69,7 @@
 // END - Embark standard lints v0.4
 // crate-specific exceptions:
 // #![allow()]
+#![doc = include_str!("../README.md")]
 
 mod depfile;
 #[cfg(feature = "watch")]
diff --git a/crates/spirv-std/README.md b/crates/spirv-std/README.md
@@ -6,7 +6,7 @@ This crate gives a `rust-gpu` shader access to the required `#![spirv(..)]` attr
 
 ## 🚨 BREAKING 🚨
 
-As of `0.4.0-alpha.16`, your shaders will require a different preamble. See [this doc][migration] for more information.
+As of `0.4.0-alpha.16`, your shaders will require a different preamble. See [this migration guide][migration] for more information.
 
 ## Example
 
diff --git a/crates/spirv-std/macros/README.md b/crates/spirv-std/macros/README.md
@@ -1,3 +1,3 @@
 # `spirv-std-macros`
 
-This crate implements macros required for `spirv-std`. Most importantly, it implements the `#![spirv(..)]` attribute macro required for use in shader code. Please refer to [`spirv-std`](https://crates.io/crates/spirv-std) for more information.
+This crate implements macros required for `spirv-std`. Most importantly, it implements the `#![spirv(..)]` attribute macro required for use in shader code. Please refer to [`spirv-std`](https://docs.rs/spirv-std/) for more information.
diff --git a/crates/spirv-std/macros/src/lib.rs b/crates/spirv-std/macros/src/lib.rs
@@ -69,6 +69,7 @@
 // END - Embark standard lints v0.4
 // crate-specific exceptions:
 // #![allow()]
+#![doc = include_str!("../README.md")]
 
 mod image;
 
diff --git a/crates/spirv-std/shared/README.md b/crates/spirv-std/shared/README.md
@@ -1,3 +1,3 @@
 # `spirv-std-types`
 
-Small shared crate, to share definitions between [`spirv-std`](https://crates.io/crates/spirv-std) and [`spirv-std-macros`](https://crates.io/crates/spirv-std-macros). Please refer to [`spirv-std`](https://crates.io/crates/spirv-std) for more information.
+Small shared crate, to share definitions between [`spirv-std`](https://docs.rs/spirv-std/) and [`spirv-std-macros`](https://docs.rs/spirv-std-macros/). Please refer to [`spirv-std`](https://docs.rs/spirv-std/) for more information.
diff --git a/crates/spirv-std/shared/src/lib.rs b/crates/spirv-std/shared/src/lib.rs
@@ -1,6 +1,4 @@
-//! Small shared crate, to share definitions between `spirv-std`
-//! and `spirv-std-macros`.
-
+#![doc = include_str!("../README.md")]
 #![no_std]
 
 pub mod image_params;
diff --git a/crates/spirv-std/src/lib.rs b/crates/spirv-std/src/lib.rs
@@ -87,9 +87,7 @@
     clippy::unimplemented,
 )]
 #![warn(missing_docs)]
-
-//! Core functions, traits, and more that make up a "standard library" for SPIR-V for use in
-//! rust-gpu.
+#![doc = include_str!("../README.md")]
 
 #[macro_use]
 pub extern crate spirv_std_macros as macros;

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	# `rustc_codegen_spirv-types`
`2`	`2`
`3`		-SPIR-V backend types shared between `rustc_codegen_spirv` and `spirv-builder`. Please refer to [`spirv-builder`](https://crates.io/crates/spirv-builder) for more information.
	`3`	+SPIR-V backend types shared between `rustc_codegen_spirv` and `spirv-builder`. Please refer to [`spirv-builder`](https://docs.rs/spirv-builder/) for more information.
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-//! Types used by both `rustc_codegen_spirv` and `spirv-builder`.
	`1`	`+#![doc = include_str!("../README.md")]`
`2`	`2`
`3`	`3`	`pub use rspirv::spirv::Capability;`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	# `spirv-std-macros`
`2`	`2`
`3`		-This crate implements macros required for `spirv-std`. Most importantly, it implements the `#![spirv(..)]` attribute macro required for use in shader code. Please refer to [`spirv-std`](https://crates.io/crates/spirv-std) for more information.
	`3`	+This crate implements macros required for `spirv-std`. Most importantly, it implements the `#![spirv(..)]` attribute macro required for use in shader code. Please refer to [`spirv-std`](https://docs.rs/spirv-std/) for more information.
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	# `spirv-std-types`
`2`	`2`
`3`		-Small shared crate, to share definitions between [`spirv-std`](https://crates.io/crates/spirv-std) and [`spirv-std-macros`](https://crates.io/crates/spirv-std-macros). Please refer to [`spirv-std`](https://crates.io/crates/spirv-std) for more information.
	`3`	+Small shared crate, to share definitions between [`spirv-std`](https://docs.rs/spirv-std/) and [`spirv-std-macros`](https://docs.rs/spirv-std-macros/). Please refer to [`spirv-std`](https://docs.rs/spirv-std/) for more information.