Merge pull request #804 from aehrc/issue/692

Issue/692
aehrc · May 22, 2024 · 391e562 · 391e562
2 parents 37f2a5c + b57aefd
commit 391e562
Show file tree

Hide file tree

Showing 64 changed files with 1,674 additions and 1,106 deletions.
diff --git a/apps/smart-forms-app/src/features/standalone/components/Standalone.tsx b/apps/smart-forms-app/src/features/standalone/components/Standalone.tsx
@@ -21,11 +21,11 @@ import type {
   RendererPropsActions,
   RendererPropsState
 } from '../interfaces/standalone.interface.ts';
-import { SmartFormsRenderer } from '@aehrc/smart-forms-renderer';
 import { rendererPropsList } from '../utils/standaloneList.ts';
 import StandaloneQuestionnairePicker from './StandaloneQuestionnairePicker.tsx';
 import StandalonePropsPicker from './StandalonePropsPicker.tsx';
 import StandaloneResourceViewer from './StandaloneResourceViewer.tsx';
+import { InitialiseFormWrapperForStorybook } from '@aehrc/smart-forms-renderer';
 
 const rendererPropsReducer = (state: RendererPropsState, action: RendererPropsActions) => {
   switch (action.type) {
@@ -86,7 +86,7 @@ function Standalone() {
                   resourcesShown={resourcesShown}
                   onShowResources={() => setResourcesShown(!resourcesShown)}
                 />
-                <SmartFormsRenderer
+                <InitialiseFormWrapperForStorybook
                   questionnaire={state.questionnaire}
                   questionnaireResponse={state.response ?? undefined}
                   additionalVariables={state.additionalVars ?? undefined}

diff --git a/documentation/docusaurus.config.ts b/documentation/docusaurus.config.ts
@@ -155,7 +155,17 @@ const config: Config = {
           }
         };
       }
-    })
+    }),
+    [
+      'docusaurus-plugin-typedoc',
+      // Options
+      {
+        excludeTags: ['@author'],
+        entryPoints: ['../packages/smart-forms-renderer/src/index.ts'],
+        tsconfig: '../packages/smart-forms-renderer/tsconfig.json',
+        out: 'docs/devUsage/api'
+      }
+    ]
   ]
 };
 

diff --git a/documentation/package.json b/documentation/package.json
@@ -32,6 +32,9 @@
     "@docusaurus/module-type-aliases": "3.3.2",
     "@docusaurus/tsconfig": "3.3.2",
     "@docusaurus/types": "3.3.2",
+    "docusaurus-plugin-typedoc": "^1.0.1",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.2",
     "typescript": "~5.2.2"
   },
   "browserslist": {

diff --git a/documentation/tsdoc.json b/documentation/tsdoc.json
@@ -0,0 +1,10 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["typedoc/tsdoc.json"],
+  "tagDefinitions": [
+    {
+      "tagName": "@author",
+      "syntaxKind": "block"
+    }
+  ]
+}