IS-11008 HAAPI React SDK documentation

.github/workflows/lwa-github-ci-workflow.yml

@@ -33,16 +33,16 @@ jobs:
         run: npm ci
 
       - name: SDK — Check Formatting
-        run: npm run prettier-check -w src/haapi-react-sdk
+        run: npm run prettier-check -w @curity/haapi-react-sdk
 
       - name: SDK — Lint
-        run: npm run lint -w src/haapi-react-sdk
+        run: npm run lint -w @curity/haapi-react-sdk
 
       - name: SDK — Typecheck
-        run: npm run typecheck -w src/haapi-react-sdk
+        run: npm run typecheck -w @curity/haapi-react-sdk
 
       - name: SDK — Run Tests
-        run: npm run test -w src/haapi-react-sdk -- run
+        run: npm run test -w @curity/haapi-react-sdk -- run
 
       - name: App — Check Formatting
         run: npm run prettier-check -w src/haapi-react-app
@@ -56,6 +56,20 @@ jobs:
       - name: App — Run Tests
         run: npm run test -w src/haapi-react-app -- run
 
+      - name: Docs — Check Formatting
+        run: npm run prettier-check -w @curity/haapi-react-sdk-docs
+
+      # Type-checks the example sources (incl. catalog.ts's mock HAAPI steps) against the SDK's
+      # published types, so the fixtures can't structurally drift from the SDK without failing CI.
+      - name: Docs — Typecheck
+        run: npm run typecheck -w @curity/haapi-react-sdk-docs
+
+      # Runs the full generator chain (predocs:build) then `docusaurus build` with
+      # `onBrokenLinks: 'throw'` — so a generator crash, a broken link/anchor or an MDX
+      # compile error fails the PR instead of surfacing on someone's next local run.
+      - name: Docs — Build
+        run: npm run docs:build -w @curity/haapi-react-sdk-docs
+
   notify-slack:
     name: Notify Slack
     needs: build-and-test

index.html

@@ -324,6 +324,14 @@
                 width: fit-content;
             }
 
+            .documentation {
+                margin-top: 1.5rem;
+                width: 100%;
+                text-align: center;
+                border-top: 1px solid #eee;
+                padding-top: 1rem;
+            }
+
             .status {
                 margin-top: auto;
                 padding-top: 1rem;
@@ -525,12 +533,22 @@ <h2>HAAPI React App</h2>
                             <span>Open previewer</span>
                         </a>
                         <small class="card-url">http://localhost:5174/</small>
+                        <div class="documentation">
+                            <a
+                                href="https://curityio.github.io/ui-kit/haapi-react-sdk/docs/overview"
+                                target="_blank"
+                                class="button button-primary-outline button-medium w100 mt2"
+                            >
+                                <span>Read HAAPI React SDK documentation</span>
+                            </a>
+                        </div>
                         <div class="commands">
                             <h3>Useful Commands</h3>
                             <code>npm install</code>
                             <code>npm run start:haapi-react-app</code>
                             <code>npm run build:haapi-react-app</code>
                         </div>
+
                         <div
                             class="status"
                             data-tooltip="Note: It may take a few seconds for the preview server to be ready"