chore: set global typedoc command

.gitignore

@@ -55,9 +55,7 @@ node_modules/
 # Generate output
 dist
 build
-docs/*
-!docs/CNAME
-!docs/index.html
+docs
 
 # Hardhat
 cache

README.md

@@ -70,7 +70,7 @@
                 <a href="https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/incremental-merkle-tree">
                     @zk-kit/incremental-merkle-tree
                 </a>
-                 <a href="https://zkkit.appliedzkp.org/incremental-merkle-tree">
+                 <a href="https://zkkit.pse.dev/modules/_zk_kit_incremental_merkle_tree">
                     (docs)
                 </a>
             </td>
@@ -118,7 +118,7 @@
                 <a href="https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/sparse-merkle-tree">
                     @zk-kit/sparse-merkle-tree
                 </a>
-                 <a href="https://zkkit.appliedzkp.org/sparse-merkle-tree/">
+                 <a href="https://zkkit.pse.dev/modules/_zk_kit_sparse_merkle_tree">
                     (docs)
                 </a>
             </td>
@@ -272,7 +272,3 @@ grep -r -l "sparse-merkle-tree" . | xargs sed -i 's/sparse-merkle-tree/my-packag
 #### How can I create benchmarks for my library?
 
 You can see some examples in the `benchmarks` folder. All you have to do is create a file that exports a function to run your benchmark in that folder, and add that function to the `index.ts` file. The `yarn benchmarks` command can be run with no parameters (it will run all the benchmarks), or you can specify the name of your benchmark file to run just that. When you run the command it will create a `benchmarks/results` folder with your results.
-
-#### How can I publish the documentation of my library with Typedocs?
-
-You just need to insert the NPM `docs` command in your `package.json` file, as in the other packages. This command will be executed by Yarn and the output of `typedocs` will be placed in the `docs` folder of the root directory, which will be used to deploy the documentation websites by the Github `docs` workflow whenever the `main` branch is updated.

package.json

@@ -18,7 +18,7 @@
         "prettier": "prettier -c .",
         "prettier:write": "prettier -w .",
         "benchmarks": "rimraf benchmarks/results && ts-node benchmarks/index.ts",
-        "docs": "yarn workspaces foreach --no-private run docs",
+        "docs": "typedoc --cname zkkit.pse.dev --githubPages true",
         "commit": "cz",
         "precommit": "lint-staged",
         "postinstall": "yarn build && husky install"
@@ -69,6 +69,7 @@
         "rollup": "^2.64.0",
         "ts-node": "^10.4.0",
         "tslib": "^2.3.1",
+        "typedoc": "^0.25.1",
         "typescript": "^4.5.4"
     },
     "config": {

packages/incremental-merkle-tree/package.json

@@ -27,8 +27,7 @@
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/incremental-merkle-tree"
+        "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
@@ -37,7 +36,6 @@
         "circomlibjs": "^0.0.8",
         "rollup-plugin-cleanup": "^3.2.1",
         "rollup-plugin-terser": "^7.0.2",
-        "rollup-plugin-typescript2": "^0.32.1",
-        "typedoc": "^0.22.11"
+        "rollup-plugin-typescript2": "^0.32.1"
     }
 }

packages/incremental-merkle-tree/typedoc.json

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

packages/lazytower/package.json

@@ -27,17 +27,15 @@
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/lazytower"
+        "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
     },
     "devDependencies": {
         "rollup-plugin-cleanup": "^3.2.1",
         "rollup-plugin-terser": "^7.0.2",
-        "rollup-plugin-typescript2": "^0.32.1",
-        "typedoc": "^0.22.11"
+        "rollup-plugin-typescript2": "^0.32.1"
     },
     "dependencies": {
         "poseidon-lite": "^0.2.0"

packages/lazytower/typedoc.json

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

packages/sparse-merkle-tree/package.json

@@ -32,8 +32,7 @@
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/sparse-merkle-tree"
+        "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
@@ -44,7 +43,6 @@
         "crypto-js": "^4.1.1",
         "rollup-plugin-cleanup": "^3.2.1",
         "rollup-plugin-terser": "^7.0.2",
-        "rollup-plugin-typescript2": "^0.32.1",
-        "typedoc": "^0.22.11"
+        "rollup-plugin-typescript2": "^0.32.1"
     }
 }

packages/sparse-merkle-tree/typedoc.json

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

typedoc.json

@@ -0,0 +1,6 @@
+{
+    "entryPoints": ["packages/*"],
+    "name": "ZK-kit",
+    "entryPointStrategy": "packages",
+    "exclude": ["**/*.sol", "**/*.circom", "**/rollup-plugin-rust"]
+}