Docs/api ref

.gitignore

@@ -56,4 +56,7 @@ logs
 *.tsbuildinfo
 
 # Optional REPL history
-.node_repl_history 
+.node_repl_history 
+
+# Docs
+docs/

.npmrc

@@ -0,0 +1 @@
+npm_config_registry=https://registry.npmjs.org

package.json

@@ -16,23 +16,32 @@
     "test:e2e": "vitest run tests/e2e",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
-    "prepublishOnly": "npm run build"
+    "docs": "typedoc",
+    "prepublishOnly": "npm run build",
+    "create-docs": "npm run create-docs:generate && npm run create-docs:process",
+    "push-docs": "node scripts/mintlify-post-processing/push-to-docs-repo.js",
+    "create-docs:generate": "typedoc",
+    "create-docs:process": "node scripts/mintlify-post-processing/file-processing/file-processing.js"
   },
   "dependencies": {
     "axios": "^1.6.2",
     "socket.io-client": "^4.7.5",
     "uuid": "^13.0.0"
   },
   "devDependencies": {
+    "@types/hast": "^3.0.4",
     "@types/node": "^25.0.1",
+    "@types/unist": "^3.0.3",
     "@vitest/coverage-istanbul": "^1.0.0",
     "@vitest/coverage-v8": "^1.0.0",
     "@vitest/ui": "^1.0.0",
     "dotenv": "^16.3.1",
     "eslint": "^8.54.0",
     "nock": "^13.4.0",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.3.2",
-    "vitest": "^1.0.0"
+    "vitest": "^1.6.1"
   },
   "keywords": [
     "base44",

scripts/mintlify-post-processing/appended-articles.json

@@ -0,0 +1,4 @@
+{
+  "interfaces/EntitiesModule": "interfaces/EntityHandler",
+  "type-aliases/integrations": "interfaces/CoreIntegrations"
+}

scripts/mintlify-post-processing/category-map.json

@@ -0,0 +1,5 @@
+{
+  "functions": "Client",
+  "interfaces": "Modules",
+  "type-aliases": "Modules"
+}

scripts/mintlify-post-processing/file-processing/docs-json-template.json

@@ -0,0 +1,62 @@
+{
+  "$schema": "https://mintlify.com/docs.json",
+  "theme": "mint",
+  "name": "Base44 Support Documentation",
+  "integrations": {
+    "mixpanel": {
+      "projectToken": "cc6e9e106e4b833fc3a3819c11b74138"
+    }
+  },
+  "colors": {
+    "primary": "#FF5500",
+    "light": "#EEE2C0",
+    "dark": "#FF5500"
+  },
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "SDK Reference",
+        "groups": [
+          {
+            "group": "Main Methods",
+            "pages": [
+              "content/functions/createClient",
+              "content/functions/createClientFromRequest",
+              "content/functions/getAccessToken",
+              "content/functions/saveAccessToken",
+              "content/functions/removeAccessToken",
+              "content/functions/getLoginUrl"
+            ]
+          },
+          {
+            "group": "Modules",
+            "pages": ["content/interfaces/Auth"]
+          }
+        ]
+      }
+    ]
+  },
+  "navbar": {
+    "links": [
+      {
+        "label": "Support",
+        "href": "https://app.base44.com/support/conversations"
+      }
+    ],
+    "primary": {
+      "type": "button",
+      "label": "Base44",
+      "href": "https://base44.com/?utm_source=Mintlify&utm_medium=Main&utm_content=menu"
+    }
+  },
+  "footer": {
+    "socials": {
+      "twitter": "https://x.com/base_44",
+      "discord": "https://discord.com/invite/ThpYPZpVts",
+      "linkedin": "https://www.linkedin.com/company/base44"
+    }
+  },
+  "custom": {
+    "stylesheets": ["/styling.css"]
+  }
+}