feat(docs): add TypeDoc for automated API documentation

Install typedoc and typedoc-plugin-markdown as devDependencies.
Add typedoc.json targeting src/transport/, src/db/, and src/hooks/,
excluding test files and page-level components. Add npm run docs script.
Add docs/api/ to .gitignore — output is generated at build time.

Closes #76
Part of epic #75

Author: morbeo

.gitignore

@@ -1,29 +1,32 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
+# Dependencies
+node_modules/
 
-node_modules
-dist
-dist-ssr
-*.local
+# Build output
+dist/
 
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
-.idea
-.DS_Store
+# Generated API docs (built by npm run docs / docs.yml CI)
+docs/api/
+
+# Coverage
+coverage/
+
+# Local env
+.env
+.env.local
+.env.*.local
+
+# Editor
+.vscode/
+.idea/
 *.suo
 *.ntvs*
 *.njsproj
 *.sln
 *.sw?
 
-archives
-scripts
-coverage
-deploy
+# OS
+.DS_Store
+Thumbs.db
+
+# Scripts (added manually with git add --force)
+scripts/

package.json

@@ -6,6 +6,7 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc -b && vite build",
+    "docs": "typedoc",
     "pack": "bash scripts/pack.sh",
     "release": "release-it",
     "release:dry": "release-it --dry-run",
@@ -59,6 +60,8 @@
     "prettier": "^3.8.1",
     "release-it": "^19.2.4",
     "tailwindcss": "^4.2.2",
+    "typedoc": "^0.28.0",
+    "typedoc-plugin-markdown": "^4.6.0",
     "typescript": "~5.9.3",
     "typescript-eslint": "^8.57.0",
     "vite": "^8.0.1",

typedoc.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPointStrategy": "expand",
+  "entryPoints": ["src/transport", "src/db", "src/hooks"],
+  "exclude": ["src/test/**", "src/pages/**", "src/components/**", "**/*.test.*"],
+  "out": "docs/api",
+  "name": "Viktorani API",
+  "readme": "none",
+  "includeVersion": true,
+  "disableSources": false,
+  "plugin": ["typedoc-plugin-markdown"]
+}