Merge remote-tracking branch 'origin/main' into struct-proposal

.github/workflows/build.yml

@@ -2,8 +2,6 @@ name: Build and release
 
 on:
   push:
-    branches:
-      - main
   workflow_dispatch:
     inputs:
       release:
@@ -45,7 +43,7 @@ jobs:
           pnpm test
 
       - name: Determine release tag
-        if: ${{ inputs.release }}
+        if: ${{ inputs.release && github.ref == 'refs/heads/main' }}
         run: |
           cd packages/reactivity-core
 
@@ -54,14 +52,14 @@ jobs:
           echo RELEASE_TAG=$NAME@$VERSION >> $GITHUB_ENV
 
       - name: Tag release
-        if: ${{ inputs.release }}
+        if: ${{ inputs.release && github.ref == 'refs/heads/main' }}
         uses: rickstaa/action-create-tag@v1
         with:
           tag: "${{ env.RELEASE_TAG }}"
           force_push_tag: true
 
       - name: Publish package
-        if: ${{ inputs.release }}
+        if: ${{ inputs.release && github.ref == 'refs/heads/main' }}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: |

README.md

@@ -5,6 +5,10 @@ Framework agnostic library for building reactive applications.
 > [!WARNING]
 > The APIs implemented in this repository are highly experimental and subject to change.
 
+## Reactivity-API
+
+See the [README of the `@conterra/reactivity-core` package](./packages/reactivity-core/README.md).
+
 ## Setup
 
 Install [pnpm](https://pnpm.io/), for example by running `npm install -g pnpm`.
@@ -38,6 +42,22 @@ $ pnpm watch-types
 You can try this library together with Vue3 in the `playground` directory.
 See [README](./playground/README.md) for more details.
 
+## Render typedoc
+
+Build typedoc output (to `dist/docs`).
+
+```bash
+$ pnpm build-docs
+```
+
+Then, use any local web server to serve the documentation.
+The following example uses [serve](https://www.npmjs.com/package/serve):
+
+```bash
+$ pnpm install -g serve # global installation; only necessary once
+$ serve dist/docs
+```
+
 ## Releasing
 
 The release process is semi-automatic at this time.

package.json

@@ -6,6 +6,7 @@
     "scripts": {
         "clean": "pnpm -r run --parallel clean",
         "build": "pnpm -r run --aggregate-output build",
+        "build-docs": "typedoc",
         "test": "pnpm -r run --aggregate-output test run",
         "check-types": "tsc",
         "watch-types": "pnpm check-types -w",
@@ -25,21 +26,13 @@
         "prettier": "^3.2.5",
         "rimraf": "^5.0.5",
         "tsx": "^4.7.2",
+        "typedoc": "^0.25.13",
         "typescript": "~5.4.4",
         "vite": "^5.2.8",
         "vitest": "^1.4.0"
     },
     "engines": {
         "node": ">= 18",
         "pnpm": "^8"
-    },
-    "pnpm": {
-        "packageExtensions": {
-            "@vue/test-utils@^2": {
-                "peerDependencies": {
-                    "vue": "^3"
-                }
-            }
-        }
     }
 }