improve docs by enabling scraped examples and bevy trait tags

1 files changed, 17 insertions, 0 deletions

diff --git a/docs-rs/README.md b/docs-rs/README.md
new file mode 100644
index 00000000..3be1087a
--- /dev/null
+++ b/docs-rs/README.md
@@ -0,0 +1,17 @@
+## Docs.rs Extensions
+
+This directory includes some templates and styling to extend and modify [rustdoc]'s output
+for Azalea's documentation on [docs.rs].
+
+See [Bevy's documentation](https://github.com/bevyengine/bevy/tree/main/docs-rs) for more info.
+
+## Local Testing
+
+Build the documentation with the extension enabled like this:
+
+```bash
+RUSTDOCFLAGS="--html-after-content docs-rs/trait-tags.html --cfg docsrs_dep" RUSTFLAGS="--cfg docsrs_dep" cargo doc --no-deps --package <package_name>
+```
+
+[rustdoc]: https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html
+[docs.rs]: https://docs.rs