1
0
mirror of https://github.com/matrix-org/matrix-authentication-service.git synced 2025-07-31 09:24:31 +03:00

Add placeholders in the documentation to make browsing the documentation source less confusing

Fixes #1078
This commit is contained in:
Quentin Gliech
2023-10-11 17:20:15 +02:00
parent 883af8217a
commit 3bcf4b2500
4 changed files with 7 additions and 2 deletions

View File

@ -7,5 +7,5 @@ A hosted version is available at <https://matrix-org.github.io/matrix-authentica
## Links
- Technical documentation for individual crates: [`rustdoc`](./rustdoc/mas_handlers/index.html)
- UI components: [`storybook`](./storybook/index.html)
- Technical documentation for individual crates: [`rustdoc`](./rustdoc/mas_handlers/)
- UI components: [`storybook`](./storybook/)

View File

@ -0,0 +1,2 @@
This is a placeholder which is replaced by the built crates technical documentation 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: <https://matrix-org.github.io/matrix-authentication-service/rustdoc/mas_handlers/>

2
docs/storybook/README.md Normal file
View File

@ -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: <https://matrix-org.github.io/matrix-authentication-service/storybook/>

View File

@ -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