From a119e53380ac7098db1913075c45489daf29b707 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martina=20Gr=C3=A4ber?= Date: Thu, 28 Mar 2024 09:09:09 +0100 Subject: [PATCH 1/2] Comments for Documentation added --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 8a97fd7e2..91a837be9 100644 --- a/README.md +++ b/README.md @@ -257,6 +257,21 @@ We plan to push updates for each minor and major product release, allowing devel - [Theming guide](./imxweb/custom-theme/readme.md) - [CDR guide](./imxweb/projects/qbm/src/lib/cdr/Readme.md) +## Documentation +The portal is documented using compodoc 1.1.10. + +There are two ways to install the documentation locally. The result will be stored in _\imxweb\documentation\_. + +### 1. The native way +1. Install the compodoc package globally using `npm install -g @compodoc/compodoc`. +2. Navigate to the folder you like to compile (_\imxweb\projects\qer_ e.g.). +3. Run `compodoc -p tsconfig.lib.json` for a library or `compodoc -p tsconfig.app.json` for an application. + +### 2. The npm way +This only works for qbm, qer and the portals (Web Portal, Operation Support Portal and the Landing Page) +1. Navigate to _imxweb_. +2. run `npm run doc:` + ## Contributing We welcome and appreciate contributions. Here's how you can open a pull request to submit code changes. From 8432d1c1b85fbfd731f9464a4868504dd5370901 Mon Sep 17 00:00:00 2001 From: Hanno Bunjes Date: Tue, 16 Apr 2024 13:58:07 +0200 Subject: [PATCH 2/2] update --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 91a837be9..e3d4fbc0a 100644 --- a/README.md +++ b/README.md @@ -258,17 +258,18 @@ We plan to push updates for each minor and major product release, allowing devel - [CDR guide](./imxweb/projects/qbm/src/lib/cdr/Readme.md) ## Documentation -The portal is documented using compodoc 1.1.10. There are two ways to install the documentation locally. The result will be stored in _\imxweb\documentation\_. -### 1. The native way -1. Install the compodoc package globally using `npm install -g @compodoc/compodoc`. -2. Navigate to the folder you like to compile (_\imxweb\projects\qer_ e.g.). +### 1. Using Compodoc (preferred) +1. Install the Compodoc package globally by running `npm install -g @compodoc/compodoc`. +2. Navigate to the library to create documentation for (e.g. `imxweb\projects\qer`). 3. Run `compodoc -p tsconfig.lib.json` for a library or `compodoc -p tsconfig.app.json` for an application. -### 2. The npm way -This only works for qbm, qer and the portals (Web Portal, Operation Support Portal and the Landing Page) +### 2. Using npm only + +This method only works for `qbm`, `qer` and the applications. + 1. Navigate to _imxweb_. 2. run `npm run doc:`