Merge pull request #101 from NillionNetwork/feature/autodocs

feat(docs): added typedoc gen script and instructions

Author: wwwehr

README.md

@@ -33,6 +33,13 @@ yarn add @nillion/client-wasm @nillion/client-vms @nillion/client-react-hooks
 - 💻 [Code examples](./client-vms/tests/) - See the TypeScript client in action
 - ⚛️ [React Hooks](./client-react-hooks/) - Learn how to use our React hooks
 
+### Build docs from source tree
+
+Clone this repo, and from the repo root run:
+```shell
+pnpm -F client-vms docs
+```
+
 ## Packages
 
 - `@nillion/client-react-hooks` - React hooks built on `@nillion/client-vms` and `@tanstack/react-query`

client-vms/package.json

@@ -15,6 +15,7 @@
     "typecheck": "tsc",
     "test": "vitest test",
     "clean": "rm -rf dist",
+    "docs": "typedoc",
     "watch:esbuild": "node esbuild.config.mjs --watch",
     "watch:types": "tsc -p tsconfig.build.json --watch",
     "build": "pnpm clean && node esbuild.config.mjs && tsc -p tsconfig.build.json",
@@ -23,8 +24,8 @@
   "dependencies": {
     "@bufbuild/protobuf": "^2.2.2",
     "@connectrpc/connect": "^2.0.0",
-    "@connectrpc/connect-web": "^2.0.0",
     "@connectrpc/connect-node": "^2.0.0",
+    "@connectrpc/connect-web": "^2.0.0",
     "@cosmjs/proto-signing": "^0.32.4",
     "@cosmjs/stargate": "^0.32.4",
     "@nillion/client-wasm": "workspace:^",
@@ -45,6 +46,7 @@
     "browserslist": "^4.24.2",
     "dotenv": "^16.4.5",
     "esbuild-plugin-browserslist": "^0.15.0",
+    "typedoc": "^0.27.7",
     "vite": "^5.4.11",
     "vite-plugin-wasm": "^3.3.0",
     "vite-tsconfig-paths": "^5.1.2",

client-vms/typedoc.json

@@ -0,0 +1,7 @@
+{
+  "entryPoints": ["./src/index.ts"],
+  "out": "docs",
+  "excludePrivate": true,
+  "excludeProtected": true,
+  "theme": "default"
+}