feat: Improve documentation integration (powerhouse-inc#58)

.dockerignore

@@ -0,0 +1,9 @@
+frontend/node_modules
+frontend/npm-debug*
+frontend/.nuxt
+frontend/dist
+frontend/tests
+frontend/.output
+frontend/content/documentation/**
+
+api/node_modules

api/package.json

@@ -15,6 +15,7 @@
         "watch": "vitest watch"
     },
     "dependencies": {
+        "@acaldas/document-model-libs": "^1.0.15",
         "@apollo/server": "^4.5.0",
         "@prisma/client": "^4.11.0",
         "@types/cookie-parser": "^1.4.3",

frontend/.dockerignore

@@ -4,3 +4,4 @@ npm-debug*
 dist
 tests
 .output
+content/documentation/**

frontend/.gitignore

@@ -7,3 +7,4 @@ node_modules
 .env
 dist
 *.sqlite
+content/documentation

frontend/Dockerfile

@@ -10,6 +10,7 @@ WORKDIR /app/frontend
 # copy the app, note .dockerignore
 COPY frontend/package.json .
 COPY frontend/package-lock.json .
+COPY frontend/scripts ./scripts
 RUN npm ci
 
 FROM dependency-base AS production-base
@@ -18,6 +19,8 @@ FROM dependency-base AS production-base
 # if necessary
 COPY frontend /app/frontend
 COPY api /app/api
+WORKDIR /app/api
+RUN npm ci
 WORKDIR /app/frontend
 RUN npm run build
 

frontend/README.md

@@ -25,8 +25,18 @@ Endpoint available at `/healthz` path. Provides response if frontend is currentl
 ## Documentation page
 
 One of the frontend's features is displaying the documentation about document model.
-The documentation is provided to the service externally as raw typedoc output in markdown format.
+The documentation is provided to the service externally as part of the npm package.
 
 To display the documentation on the frontend the provided data has to be processed and represented in the form of a single file.
 
-TODO: add the precise process in separate issue
+The documentation gets updated or generated before `npm run build`.
+
+To run the generation manually:
+
+1. Run `npm install` in the `/api` directory of the project.
+2. Run `npm install` in the `/frontend` direcotry of the project.
+3. Run the following command:
+
+```sh
+$ npm run generateDocs
+```