feat: add TypeDoc API reference deployed to GitHub Pages

.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*.*.*"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    name: Deploy TypeDoc to Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+
+      - run: npm ci
+
+      - run: npm run build
+
+      - run: npm run docs
+
+      - uses: actions/configure-pages@v5
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: api-docs/
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,5 +1,6 @@
 node_modules/
 dist/
+api-docs/
 *.tsbuildinfo
 coverage/
 .vitest/

README.md

@@ -113,6 +113,7 @@ Runnable examples in the [`examples/`](examples/) directory:
 
 ## Documentation
 
+- 📖 [API Reference](https://opendecree.github.io/decree-typescript) -- full TypeDoc API reference
 - [Quick Start](docs/quickstart.md) -- install, first get/set, typed gets, error handling
 - [Configuration](docs/configuration.md) -- all client options, auth, TLS, retry, timeouts
 - [Watching](docs/watching.md) -- ConfigWatcher, WatchedField, EventEmitter, async iteration