From bcea592c04d5e174f61b82325b0f783ae47c2fba Mon Sep 17 00:00:00 2001 From: Quentin Gliech Date: Fri, 27 Jan 2023 15:31:00 +0100 Subject: [PATCH] ci: Build Storybook docs in CI --- .github/workflows/docs.yaml | 15 +++++++++++++++ docs/README.md | 5 +++++ 2 files changed, 20 insertions(+) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 125f1f315..b246d3b42 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -35,12 +35,27 @@ jobs: with: mdbook-version: '0.4.25' + - name: Install Node + uses: actions/setup-node@v3 + with: + node-version: 18 + cache: 'npm' + cache-dependency-path: frontend/package-lock.json + + - name: Install Node dependencies + working-directory: ./frontend + run: npm ci + - name: Build the documentation run: mdbook build - name: Build rustdoc run: cargo doc -Zrustdoc-map --workspace --lib --no-deps + - name: Build storybook + working-directory: ./frontend + run: npx storybook build -o ../target/book/storybook + - name: Move the Rust documentation within the mdBook run: mv target/doc target/book/rustdoc diff --git a/docs/README.md b/docs/README.md index 8055157d0..42e406fdf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,8 @@ # About this documentation This documentation is intended to give an overview of how the `matrix-authentication-service` works, both from a admin perspective as well as from a developper perspective. + +## Links + + - Technical documentation for individual crates: [`rustdoc`](../rustdoc/mas_handlers/index.html) + - UI components: [`storybook`](../storybook/index.html)