fix: docs build (uncefact#146)

ashleythedeveloper · Nov 1, 2024 · dd8b307 · dd8b307
1 parent 0c29b69
commit dd8b307
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 10 deletions.
diff --git a/.github/workflows/build_test.yml b/.github/workflows/build_test.yml
@@ -49,3 +49,24 @@ jobs:
             Services, ./packages/services/coverage/coverage-summary.json
             UNTP test suite, ./packages/untp-test-suite/coverage/coverage-summary.json
             VC test suite, ./packages/vc-test-suite/coverage/coverage-summary.json
+
+  build_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: yarn
+
+      - name: Install and build documentation
+        run: |
+          cd documentation
+          yarn install --frozen-lockfile
+          yarn build
+        env:
+          DOCS_BASE_URL: ${{ vars.DOCS_BASE_URL }}
+          DOCS_URL: ${{ vars.DOCS_URL }}
diff --git a/documentation/docs/mock-apps/components/import-button.md b/documentation/docs/mock-apps/components/import-button.md
@@ -42,8 +42,8 @@ The ImportButton component is responsible for rendering a button that allows the
 
 #### vcOptions
 
-| Property       | Required | Description                                                                | Type   |
-| -------------- | -------- | -------------------------------------------------------------------------- | ------ |
-| credentialPath | Yes      | The path for the credential data                                           | String |
-| vckitAPIUrl    | No       | The URL for the vckit API                                                  | String |
-| headers        | No       | The headers for the vckit API, example: { Authorization: "Bearer test123"} | Object |
+| Property       | Required | Description                                                                  | Type   |
+| -------------- | -------- | ---------------------------------------------------------------------------- | ------ |
+| credentialPath | Yes      | The path for the credential data                                             | String |
+| vckitAPIUrl    | No       | The URL for the vckit API                                                    | String |
+| headers        | No       | The headers for the vckit API, example: \{ Authorization: "Bearer test123"\} | Object |
diff --git a/documentation/docs/mock-apps/components/qr-code-scanner-dialog-button.md b/documentation/docs/mock-apps/components/qr-code-scanner-dialog-button.md
@@ -6,6 +6,7 @@ title: QR Code Scanner Dialog Button
 import Disclaimer from '../../\_disclaimer.mdx';
 
 <Disclaimer />
+
 ## Description
 
 The QRCodeScannerDialogButton component is responsible for rendering a button that allows the user to scan a QR code. The component will return the data that is scanned by the user.
@@ -40,8 +41,8 @@ The QRCodeScannerDialogButton component is responsible for rendering a button th
 
 #### vcOptions
 
-| Property       | Required | Description                                                                | Type   |
-| -------------- | -------- | -------------------------------------------------------------------------- | ------ |
-| credentialPath | Yes      | The path for the credential data that is fetched from the QR code URL      | String |
-| vckitAPIUrl    | No       | The URL for the vckit API                                                  | String |
-| headers        | No       | The headers for the vckit API, example: { Authorization: "Bearer test123"} | Object |
+| Property       | Required | Description                                                                  | Type   |
+| -------------- | -------- | ---------------------------------------------------------------------------- | ------ |
+| credentialPath | Yes      | The path for the credential data that is fetched from the QR code URL        | String |
+| vckitAPIUrl    | No       | The URL for the vckit API                                                    | String |
+| headers        | No       | The headers for the vckit API, example: \{ Authorization: "Bearer test123"\} | Object |