Merge pull request #17 from ralphschuler/devel

docs: stuff
ralphschuler · Nov 26, 2023 · 5015298 · 5015298
2 parents 2bcc527 + 6a4c49b
commit 5015298
Show file tree

Hide file tree

Showing 32 changed files with 281 additions and 38 deletions.
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
     "docs:all": "yarn docs:build; yarn docs:bundle:markdown && yarn docs:bundle:html",
     "docs:build": "yarn workspaces foreach -Apt run docs",
     "docs:bundle:markdown": "yarn typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme --out docs/markdown --entryPointStrategy merge \"./**/docs/*.json\"",
-    "docs:bundle:html": "yarn typedoc --out docs/html --entryPointStrategy merge \"./**/docs/*.json\"",
+    "docs:bundle:html": "yarn typedoc --out docs/html --theme typedoc-neo-theme --entryPointStrategy merge \"./**/docs/*.json\"",
     "publish": "yarn workspaces foreach -Apt run publish",
     "husky:install": "husky install",
     "prepare": "yarn husky:install && yarn workspaces foreach -Apt run prepare",
@@ -34,6 +34,8 @@
     "husky": "^8.0.3",
     "typedoc": "^0.25.3",
     "typedoc-github-wiki-theme": "^1.1.0",
-    "typedoc-plugin-markdown": "^3.17.1"
+    "typedoc-neo-theme": "^1.1.1",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typedoc-plugin-rename-defaults": "^0.7.0"
   }
 }
diff --git a/packages/ai-function-caller/package.json b/packages/ai-function-caller/package.json
@@ -29,7 +29,7 @@
     "web-streams-polyfill": "^3.2.1"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/assert/package.json b/packages/assert/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/better-map/package.json b/packages/better-map/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/better-set/package.json b/packages/better-set/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/binary-serializer/package.json b/packages/binary-serializer/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/bit-mask/package.json b/packages/bit-mask/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/complex-compare/package.json b/packages/complex-compare/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/i811n/package.json b/packages/i811n/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/logger/package.json b/packages/logger/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/lsystem/package.json b/packages/lsystem/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/mixin-class-factory/package.json b/packages/mixin-class-factory/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/neuronal-network/package.json b/packages/neuronal-network/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/parser-combinator/package.json b/packages/parser-combinator/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/priority-queue/package.json b/packages/priority-queue/package.json
@@ -29,7 +29,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/prom-metrics-decorator/package.json b/packages/prom-metrics-decorator/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/prom-metrics-parser/package.json b/packages/prom-metrics-parser/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/random/package.json b/packages/random/package.json
@@ -29,7 +29,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/reactivity/package.json b/packages/reactivity/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/safe-array/package.json b/packages/safe-array/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/signature/package.json b/packages/signature/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/slot-mashine/package.json b/packages/slot-mashine/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/state-machine/package.json b/packages/state-machine/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/state-store/package.json b/packages/state-store/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/stats-tracker/package.json b/packages/stats-tracker/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/task-manager/package.json b/packages/task-manager/package.json
@@ -33,7 +33,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/ts-error/package.json b/packages/ts-error/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/webgl-sand-engine/package.json b/packages/webgl-sand-engine/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/webgl-shader-factory/package.json b/packages/webgl-shader-factory/package.json
@@ -28,7 +28,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",

diff --git a/packages/worker-pool/package.json b/packages/worker-pool/package.json
@@ -32,7 +32,7 @@
     "typescript": "^5.2.2"
   },
   "scripts": {
-    "docs": "typedoc --json docs/docs.json",
+    "docs": "typedoc --plugin typedoc-plugin-rename-defaults --json docs/docs.json",
     "build": "tsc",
     "publish": "yarn npm publish",
     "test": "echo \"Error: no test specified\" && exit 0",