From 3bcf4b2500530c62db8c217e612e700fb5019e66 Mon Sep 17 00:00:00 2001 From: Quentin Gliech Date: Wed, 11 Oct 2023 17:20:15 +0200 Subject: [PATCH] Add placeholders in the documentation to make browsing the documentation source less confusing Fixes #1078 --- docs/README.md | 4 ++-- docs/rustdoc/mas_handlers/README.md | 2 ++ docs/storybook/README.md | 2 ++ misc/build-docs.sh | 1 + 4 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 docs/rustdoc/mas_handlers/README.md create mode 100644 docs/storybook/README.md diff --git a/docs/README.md b/docs/README.md index e4dee158..9ae3f3c2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,5 +7,5 @@ A hosted version is available at diff --git a/docs/storybook/README.md b/docs/storybook/README.md new file mode 100644 index 00000000..2021b392 --- /dev/null +++ b/docs/storybook/README.md @@ -0,0 +1,2 @@ +This is a placeholder which is replaced by the built Storybook when building the documentation. +If you're seeing this, you're probably looking at the documentation source, and should look at the built documentation instead here: \ No newline at end of file diff --git a/misc/build-docs.sh b/misc/build-docs.sh index 391d12c8..e849e7eb 100644 --- a/misc/build-docs.sh +++ b/misc/build-docs.sh @@ -43,6 +43,7 @@ env RUSTC_BOOTSTRAP=1 \ rm target/doc/.lock # Move the Rust documentation within the mdBook +rm -rf target/book/rustdoc mv target/doc target/book/rustdoc # Build the frontend storybook