@aztec/docs 0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2

package/README.md

@@ -0,0 +1,21 @@
+# Docs
+
+To generate docs. Go to the root of `yarn-project` and run:
+
+```bash
+yarn docs
+```
+
+This will generate the html, and start a server to expose it on port `8080`, if run from external server (the mainframe) you can add `LocalForward 8080 <IP>:8080` to your ssh-config, and access it from your browser.
+
+## Adding a new package
+
+To include a new package in the set that we generate documentation for add it to the `entrypoints` list in the `yarn-project/typedoc.json`, then in the `package.json` for the new package add typedoc similar to example below:
+
+```json
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "displayName": "Aztec cli",
+    "tsconfig": "./tsconfig.json"
+  },
+```

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@aztec/docs",
+  "version": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+  "packageManager": "yarn@4.5.2",
+  "scripts": {
+    "prepare": "",
+    "build": "vite build",
+    "serve": "vite preview --port 8080 --host 0.0.0.0"
+  },
+  "devDependencies": {
+    "vite": "^4.2.3"
+  }
+}