Refactor docs and contribution guides (#199)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
DigitecGalaxus · Nov 8, 2024 · 82e86a0 · 82e86a0
1 parent bc7a02c
commit 82e86a0
Show file tree

Hide file tree

Showing 13 changed files with 7,084 additions and 6,134 deletions.
diff --git a/.changeset/lucky-rabbits-hang.md b/.changeset/lucky-rabbits-hang.md
@@ -0,0 +1,3 @@
+---
+---
+
diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml
@@ -2,7 +2,7 @@ name: autofix.ci
 on:
   pull_request:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
 permissions:
   contents: read
 
@@ -21,7 +21,7 @@ jobs:
       - uses: pnpm/action-setup@v4
         name: Install pnpm
         with:
-          version: 8.6.1
+          version: 9.12.3
           run_install: false
 
       - name: Get pnpm store directory
@@ -49,4 +49,4 @@ jobs:
       - name: Benchmarks
         run: npx prettier --write "packages/benchmarks/**/*.{ts,tsx}" --ignore-path "packages/benchmarks/.prettierignore"
 
-      - uses: autofix-ci/action@d3e591514b99d0fca6779455ff8338516663f7cc
+      - uses: autofix-ci/action@d3e591514b99d0fca6779455ff8338516663f7cc
diff --git a/.github/workflows/changeset.yml b/.github/workflows/changeset.yml
@@ -17,14 +17,13 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '20.x'
+          node-version: "20.x"
 
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 8.6.1
+          version: 9.12.3
           run_install: true
 
       - name: Check for changeset
         run: npx changeset status --since=origin/main
-
diff --git a/.github/workflows/codspeed.yml b/.github/workflows/codspeed.yml
@@ -2,19 +2,19 @@ name: codspeed-benchmarks
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
     paths:
-      - 'packages/next-yak/**'
-      - 'packages/yak-swc/**'
-      - 'packages/benchmarks/**'
-      - '.github/workflows/codspeed.yml'
+      - "packages/next-yak/**"
+      - "packages/yak-swc/**"
+      - "packages/benchmarks/**"
+      - ".github/workflows/codspeed.yml"
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
     paths:
-      - 'packages/next-yak/**'
-      - 'packages/yak-swc/**'
-      - 'packages/benchmarks/**'
-      - '.github/workflows/codspeed.yml'
+      - "packages/next-yak/**"
+      - "packages/yak-swc/**"
+      - "packages/benchmarks/**"
+      - ".github/workflows/codspeed.yml"
   workflow_dispatch:
 
 jobs:
@@ -30,7 +30,7 @@ jobs:
       - uses: pnpm/action-setup@v4
         name: Install pnpm
         with:
-          version: 8.6.1
+          version: 9.12.3
           run_install: false
       - name: Get pnpm store directory
         shell: bash

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -24,7 +24,7 @@ jobs:
       - uses: pnpm/action-setup@v4
         name: Install pnpm
         with:
-          version: 8.6.1
+          version: 9.12.3
           run_install: false
       - name: Get pnpm store directory
         shell: bash

diff --git a/.github/workflows/example.yml b/.github/workflows/example.yml
@@ -14,59 +14,59 @@ jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: pnpm/action-setup@v4
-      name: Install pnpm
-      with:
-        version: 8.6.1
-        run_install: false
-    - name: Install Node.js
-      uses: actions/setup-node@v3
-      with:
-        node-version: 20
-        cache: 'pnpm'
-    - name: Install node_modules
-      run: pnpm install
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 9.12.3
+          run_install: false
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: "pnpm"
+      - name: Install node_modules
+        run: pnpm install
 
-    - name: Install Rust
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: stable
-        profile: minimal
-        override: true
-    - name: Add wasm32-wasi target
-      run: rustup target add wasm32-wasi
-    - name: Enable caching
-      uses: Swatinem/rust-cache@v2
-      with:
-        workspaces: packages/yak-swc
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+      - name: Add wasm32-wasi target
+        run: rustup target add wasm32-wasi
+      - name: Enable caching
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: packages/yak-swc
 
-    - name: Build with SWC
-      run: pnpm run build:swc
+      - name: Build with SWC
+        run: pnpm run build:swc
 
-    - name: Install Vercel CLI
-      run: npm install -g vercel@35
-    - name: Link Vercel project
-      run: vercel link --yes --token ${{ secrets.VERCEL_TOKEN }}
-
-    # Preview deployment (for pull requests and non-main pushes)
-    - name: Pull Vercel environment information (Preview)
-      if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
-      run: vercel pull --yes --environment=preview --token ${{ secrets.VERCEL_TOKEN }}
-    - name: Build project artifacts (Preview)
-      if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
-      run: vercel build --token ${{ secrets.VERCEL_TOKEN }}
-    - name: Deploy to Vercel (Preview)
-      if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
-      run: vercel deploy --prebuilt --token ${{ secrets.VERCEL_TOKEN }}
+      - name: Install Vercel CLI
+        run: npm install -g vercel@35
+      - name: Link Vercel project
+        run: vercel link --yes --token ${{ secrets.VERCEL_TOKEN }}
 
-    # Production deployment (for main branch pushes)
-    - name: Pull Vercel environment information (Production)
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-      run: vercel pull --yes --environment=production --token ${{ secrets.VERCEL_TOKEN }}
-    - name: Build project artifacts (Production)
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-      run: vercel build --prod --token ${{ secrets.VERCEL_TOKEN }}
-    - name: Deploy to Vercel (Production)
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-      run: vercel deploy --prebuilt --prod --token ${{ secrets.VERCEL_TOKEN }}
+      # Preview deployment (for pull requests and non-main pushes)
+      - name: Pull Vercel environment information (Preview)
+        if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
+        run: vercel pull --yes --environment=preview --token ${{ secrets.VERCEL_TOKEN }}
+      - name: Build project artifacts (Preview)
+        if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
+        run: vercel build --token ${{ secrets.VERCEL_TOKEN }}
+      - name: Deploy to Vercel (Preview)
+        if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
+        run: vercel deploy --prebuilt --token ${{ secrets.VERCEL_TOKEN }}
+
+      # Production deployment (for main branch pushes)
+      - name: Pull Vercel environment information (Production)
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: vercel pull --yes --environment=production --token ${{ secrets.VERCEL_TOKEN }}
+      - name: Build project artifacts (Production)
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: vercel build --prod --token ${{ secrets.VERCEL_TOKEN }}
+      - name: Deploy to Vercel (Production)
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: vercel deploy --prebuilt --prod --token ${{ secrets.VERCEL_TOKEN }}
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -2,23 +2,22 @@ name: Vite-Tests
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
     paths:
-      - './package.json'
-      - 'packages/next-yak/**'
-      - 'packages/yak-swc/**'
-      - '.github/workflows/node.js.yml'
+      - "./package.json"
+      - "packages/next-yak/**"
+      - "packages/yak-swc/**"
+      - ".github/workflows/node.js.yml"
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
     paths:
-      - './package.json'
-      - 'packages/next-yak/**'
-      - 'packages/yak-swc/**'
-      - '.github/workflows/node.js.yml'
+      - "./package.json"
+      - "packages/next-yak/**"
+      - "packages/yak-swc/**"
+      - ".github/workflows/node.js.yml"
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
@@ -33,7 +32,7 @@ jobs:
       - uses: pnpm/action-setup@v4
         name: Install pnpm
         with:
-          version: 8.6.1
+          version: 9.12.3
           run_install: false
 
       - name: Install Rust
@@ -49,7 +48,7 @@ jobs:
         with:
           workspaces: packages/yak-swc
       - name: Build with SWC
-        run: pnpm run build:swc    
+        run: pnpm run build:swc
 
       - name: Get pnpm store directory
         shell: bash
@@ -66,9 +65,9 @@ jobs:
 
       - name: Install dependencies
         run: pnpm install
-      
+
       - name: Build
         run: pnpm run build
 
       - name: Test
-        run: pnpm run test
+        run: pnpm run test