chore: generate docs

.gitignore

@@ -12,3 +12,4 @@ dist/
 *.log
 .DS_Store
 .pnp*
+docs/

package.json

@@ -8,7 +8,8 @@
     "start": "yarn build && yarn workspace @snort/app start",
     "test": "yarn build && yarn workspace @snort/app test && yarn workspace @snort/system test",
     "pre:commit": "yarn workspace @snort/app intl-extract && yarn workspace @snort/app intl-compile && yarn prettier --write .",
-    "push-prod": "git checkout snort-prod && git merge --ff-only main && git push && git checkout main"
+    "push-prod": "git checkout snort-prod && git merge --ff-only main && git push && git checkout main",
+    "docs": "typedoc --entryPointStrategy packages ./packages/* --exclude ./packages/app --exclude ./packages/webrtc-server --name snort.social"
   },
   "prettier": {
     "printWidth": 120,
@@ -23,5 +24,8 @@
     "eslint": "^8.48.0",
     "prettier": "^3.0.3",
     "typescript": "^5.2.2"
+  },
+  "devDependencies": {
+    "typedoc": "^0.25.7"
   }
 }

packages/shared/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+  ]
+}

packages/system-react/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+  ]
+}

packages/system-svelte/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+  ]
+}

packages/system-wasm/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "pkg/system_wasm.d.ts",
+  ]
+}

packages/system-web/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+  ]
+}

packages/system/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+  ]
+}

yarn.lock

@@ -4226,6 +4226,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"ansi-sequence-parser@npm:^1.1.0":
+  version: 1.1.1
+  resolution: "ansi-sequence-parser@npm:1.1.1"
+  checksum: ead5b15c596e8e85ca02951a844366c6776769dcc9fd1bd3a0db11bb21364554822c6a439877fb599e7e1ffa0b5f039f1e5501423950457f3dcb2f480c30b188
+  languageName: node
+  linkType: hard
+
 "ansi-styles@npm:^3.2.1":
   version: 3.2.1
   resolution: "ansi-styles@npm:3.2.1"
@@ -8266,6 +8273,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"lunr@npm:^2.3.9":
+  version: 2.3.9
+  resolution: "lunr@npm:2.3.9"
+  checksum: 176719e24fcce7d3cf1baccce9dd5633cd8bdc1f41ebe6a180112e5ee99d80373fe2454f5d4624d437e5a8319698ca6837b9950566e15d2cae5f2a543a3db4b8
+  languageName: node
+  linkType: hard
+
 "magic-string@npm:^0.25.0, magic-string@npm:^0.25.7":
   version: 0.25.9
   resolution: "magic-string@npm:0.25.9"
@@ -8337,6 +8351,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"marked@npm:^4.3.0":
+  version: 4.3.0
+  resolution: "marked@npm:4.3.0"
+  bin:
+    marked: bin/marked.js
+  checksum: 0db6817893952c3ec710eb9ceafb8468bf5ae38cb0f92b7b083baa13d70b19774674be04db5b817681fa7c5c6a088f61300815e4dd75a59696f4716ad69f6260
+  languageName: node
+  linkType: hard
+
 "marked@npm:^9.1.0":
   version: 9.1.6
   resolution: "marked@npm:9.1.6"
@@ -8435,7 +8458,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"minimatch@npm:^9.0.1":
+"minimatch@npm:^9.0.1, minimatch@npm:^9.0.3":
   version: 9.0.3
   resolution: "minimatch@npm:9.0.3"
   dependencies:
@@ -10280,6 +10303,7 @@ __metadata:
     "@tauri-apps/cli": ^1.2.3
     eslint: ^8.48.0
     prettier: ^3.0.3
+    typedoc: ^0.25.7
     typescript: ^5.2.2
   languageName: unknown
   linkType: soft
@@ -10416,6 +10440,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"shiki@npm:^0.14.7":
+  version: 0.14.7
+  resolution: "shiki@npm:0.14.7"
+  dependencies:
+    ansi-sequence-parser: ^1.1.0
+    jsonc-parser: ^3.2.0
+    vscode-oniguruma: ^1.7.0
+    vscode-textmate: ^8.0.0
+  checksum: 2aec3b3519df977c4391df9e1825cb496e9a4d7e11395f05a0da77e4fa2f7c3d9d6e6ee94029ac699533017f2b25637ee68f6d39f05f311535c2704d0329b520
+  languageName: node
+  linkType: hard
+
 "side-channel@npm:^1.0.4":
   version: 1.0.4
   resolution: "side-channel@npm:1.0.4"
@@ -11292,6 +11328,22 @@ __metadata:
   languageName: node
   linkType: hard
 
+"typedoc@npm:^0.25.7":
+  version: 0.25.7
+  resolution: "typedoc@npm:0.25.7"
+  dependencies:
+    lunr: ^2.3.9
+    marked: ^4.3.0
+    minimatch: ^9.0.3
+    shiki: ^0.14.7
+  peerDependencies:
+    typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x
+  bin:
+    typedoc: bin/typedoc
+  checksum: 49c3bf923a3c9401b549e5843f8efaaac8fa28f8ec6bd8617187b5d9ba9932a3fa63dc3863b82389507ffc7d92908af0dce33780fffb4970cd0833274f6fa0cf
+  languageName: node
+  linkType: hard
+
 "typescript-lru-cache@npm:^2.0.0":
   version: 2.0.0
   resolution: "typescript-lru-cache@npm:2.0.0"
@@ -11722,6 +11774,20 @@ __metadata:
   languageName: node
   linkType: hard
 
+"vscode-oniguruma@npm:^1.7.0":
+  version: 1.7.0
+  resolution: "vscode-oniguruma@npm:1.7.0"
+  checksum: 53519d91d90593e6fb080260892e87d447e9b200c4964d766772b5053f5699066539d92100f77f1302c91e8fc5d9c772fbe40fe4c90f3d411a96d5a9b1e63f42
+  languageName: node
+  linkType: hard
+
+"vscode-textmate@npm:^8.0.0":
+  version: 8.0.0
+  resolution: "vscode-textmate@npm:8.0.0"
+  checksum: 127780dfea89559d70b8326df6ec344cfd701312dd7f3f591a718693812b7852c30b6715e3cfc8b3200a4e2515b4c96f0843c0eacc0a3020969b5de262c2a4bb
+  languageName: node
+  linkType: hard
+
 "w3c-xmlserializer@npm:^4.0.0":
   version: 4.0.0
   resolution: "w3c-xmlserializer@npm:4.0.0"