Code quality improvements

.github/workflows/docs.yml

@@ -0,0 +1,57 @@
+name: Deploy docs
+
+on:
+  push:
+    branches: [main, master]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Setup Node.js
+        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
+        with:
+          node-version: "24"
+          package-manager-cache: false
+
+      - name: Use npm 12
+        working-directory: ${{ runner.temp }}
+        run: npm install -g npm@12
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build docs
+        run: npm run docs
+
+      - name: Configure Pages
+        uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
+
+      - name: Upload docs artifact
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
+        with:
+          path: docs
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1

.github/workflows/test.yml

@@ -41,6 +41,9 @@ jobs:
       - name: Lint and typecheck
         run: npm run check
 
+      - name: Check formatting
+        run: npm run format:check
+
       - name: Run tests with coverage
         run: npm run test:coverage
 

.gitignore

@@ -1,5 +1,6 @@
 node_modules/
 dist/
+docs/
 coverage/
 junit.xml
 .mypy_cache/

README.md

@@ -122,20 +122,19 @@ console.log(series.autocorr());   // lag-1 autocorrelation of demeaned returns
 
 API reference: <https://captorab.github.io/openseries-ts/>
 
-To regenerate docs locally:
+Docs are built with [TypeDoc](https://typedoc.org/) and deployed to GitHub
+Pages automatically by
+[`.github/workflows/docs.yml`](.github/workflows/docs.yml) on every push to
+`master`. The generated `docs/` folder is not committed to the repo
+(see `.gitignore`).
+
+To preview docs locally:
 
 ```bash
 npm run docs
 ```
 
-This writes static HTML to `docs/`. To serve them via GitHub Pages:
-
-1. Run `npm run docs` and commit the `docs/` folder
-2. In the repo: **Settings → Pages**
-3. Under **Source**, choose **Deploy from a branch**
-4. Branch: `main` (or your default branch), folder: `/docs`
-
-Docs will be available at `https://<username>.github.io/<repo>/`.
+This writes static HTML to `docs/`.
 
 ## Scripts