Merge pull request gutentag2012#4 from gutentag2012/docs

Docs

.github/workflows/ci.yml

@@ -42,4 +42,5 @@ jobs:
           node-version: 20
           cache: 'pnpm'
       - run: pnpm install --frozen-lockfile
+      - run: pnpm build
       - run: pnpm test

.github/workflows/deploy-docs.yml

@@ -0,0 +1,55 @@
+name: Deploy Docs to Pages
+
+on:
+  push:
+    branches: [main]
+    paths: ['docs/**']
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build with VitePress
+        run: pnpm docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,7 +1,5 @@
-<img src="https://github.com/gutentag2012/form-signals/raw/main/assets/repo-banner.svg" alt="Signal Form Banner" width="100%">
+<img src="https://github.com/gutentag2012/form-signals/raw/main/assets/repo-banner-light.svg" alt="Signal Form Banner" width="100%">
 
-
-[//]: # (TODO Add badges)
 [![form-core-version](https://img.shields.io/npm/v/%40formsignals%2Fform-core?style=for-the-badge&logo=npm&label=form-core)](https://www.npmjs.com/package/@formsignals/form-core)
 [![form-react-version](https://img.shields.io/npm/v/%40formsignals%2Fform-react?style=for-the-badge&logo=npm&label=form-react)](https://www.npmjs.com/package/@formsignals/form-react)
 [![validation-adapter-zod-version](https://img.shields.io/npm/v/%40formsignals%2Fvalidation-adapter-zod?style=for-the-badge&logo=npm&label=validation-adapter-zod)](https://www.npmjs.com/package/@formsignals/validation-adapter-zod) <br/>
@@ -15,8 +13,8 @@ Powerful form management library build on top of [Preact Signals](https://github
 
 ## Features
 
-- **TypeScript** - Written in TypeScript with full type support.
-- **Reactivity** - Reactivity without abstractions due to Preact Signals.
+- **TypeScript** - Written in TypeScript with full type support for optimal DX.
+- **Reactivity** - Reactivity without abstractions thanks to Preact Signals.
 - **Validation** - Built-in validation support, including adapters for validation schema libraries.
 - **React** - React bindings for easy integration with React.