build(project): move typedoc generated docs to typedocs folder

.github/workflows/main.yml

@@ -27,11 +27,11 @@ jobs:
         run: npm ci --legacy-peer-deps
 
       - name: Create the docs directory locally in CI
-        run: npx typedoc && node runner.js prepare:docs
+        run: npx typedoc --out typedocs && node runner.js prepare:docs
 
       - name: Deploy 🚀
         uses: JamesIves/[email protected]
         with:
           branch: gh-pages
-          folder: docs
+          folder: typedocs
 

.gitignore

@@ -3,6 +3,7 @@
 # compiled output
 dist
 tmp
+temp
 /out-tsc
 
 # dependencies
@@ -39,7 +40,6 @@ testem.log
 Thumbs.db
 /deployment/
 /doc/
-/docs
 /deploy.config.json
 /extern/
 
@@ -53,3 +53,4 @@ deploy
 .nx/cache
 .nx/workspace-data
 /deploy.sh
+/typedocs

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "start": "nx serve octra",
     "build": "nx build octra",
-    "build:docs": "typedoc && node runner.js prepare:docs",
+    "build:docs": "typedoc --out typedocs && node runner.js prepare:docs",
     "build:release": "node runner.js build:release",
     "build:dev": "node runner.js build:dev",
     "build:beta": "node runner.js build:beta",

runner.js

@@ -45,14 +45,14 @@ const Project = {
     await fs.copyFile(`./LICENSE.txt`, `./libs/ngx-utilities/LICENSE.txt`);
   },
   prepareDocs: async function () {
-    let content = await fs.readFile(`./docs/index.html`, 'utf-8');
+    let content = await fs.readFile(`./typedocs/index.html`, 'utf-8');
     content = content.replace(/\.\/([^/]+)\/src\//g, (g0, g1) => {
       return `modules/_octra_${g1.replace(/-/g, '_')}.html`;
     });
     content = content.replace(/apps\/([^/]+)\/src\//g, (g0, g1) => {
       return `modules/_octra_${g1.replace(/-/g, '_')}.html`;
     });
-    await fs.writeFile(`./docs/index.html`, content, {
+    await fs.writeFile(`./typedocs/index.html`, content, {
       encoding: 'utf-8',
     });
   },