Follow standard Socketry project and workflow conventions

Author: samuel-williams-shopify

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

.github/copilot-instructions.md

@@ -0,0 +1,20 @@
+# GitHub Copilot Instructions
+
+## Use Agent Context
+
+When working on this project, consult the `agents.md` file for project-specific guidelines, architecture decisions, and development patterns. This file contains curated information that will help you make better decisions aligned with the project's goals and standards.
+
+If the file does not exist, you will need to install it, by running the following command:
+
+```bash
+$ bundle install
+$ bundle exec bake agent:context:install
+```
+
+This command will set up the necessary context files that help you understand the project structure, dependencies, and conventions.
+
+## Ignoring Files
+
+The `.gitignore` file is split into two sections, separated by a blank line. The first section is automatically generated, while the second section is user controlled.
+
+While working on pull requests, you should not add unrelated changes to the `.gitignore` file as part of the pull request.

.github/release-rules/checks.json

@@ -25,16 +25,25 @@
         "do_not_enforce_on_create": false,
         "required_status_checks": [
           {
-            "context": "Test Ruby 3.3"
+            "context": "3.3 on ubuntu"
           },
           {
-            "context": "Test Ruby 3.4"
+            "context": "3.3 on macos"
           },
           {
-            "context": "Test Ruby 4.0"
+            "context": "3.4 on ubuntu"
           },
           {
-            "context": "RuboCop"
+            "context": "3.4 on macos"
+          },
+          {
+            "context": "4.0 on ubuntu"
+          },
+          {
+            "context": "4.0 on macos"
+          },
+          {
+            "context": "check"
           },
           {
             "context": "ruby on ubuntu"

.github/workflows/documentation.yaml

@@ -0,0 +1,58 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment:
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+env:
+  BUNDLE_WITH: maintenance
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v7
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ruby
+        bundler-cache: true
+    
+    - name: Installing packages
+      run: sudo apt-get install wget
+    
+    - name: Generate documentation
+      timeout-minutes: 5
+      run: bundle exec bake utopia:project:static --force no
+    
+    - name: Upload documentation artifact
+      uses: actions/upload-pages-artifact@v5
+      with:
+        path: docs
+  
+  deploy:
+    runs-on: ubuntu-latest
+    
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    
+    needs: generate
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

.github/workflows/rubocop.yaml

@@ -7,14 +7,15 @@ permissions:
 
 jobs:
   check:
-    name: RuboCop
     runs-on: ubuntu-latest
+    
     steps:
-      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
-      - uses: ruby/setup-ruby@a0102e0972be65f351c307e2d64b9314a57c8073 # v1
-        with:
-          ruby-version: "3.4"
-          bundler-cache: true
-      - name: Check Ruby and documentation style
-        timeout-minutes: 10
-        run: bundle exec rubocop
+    - uses: actions/checkout@v7
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ruby
+        bundler-cache: true
+    
+    - name: Run RuboCop
+      timeout-minutes: 10
+      run: bundle exec rubocop

.github/workflows/test.yaml

@@ -7,18 +7,41 @@ permissions:
 
 jobs:
   test:
-    name: Test Ruby ${{ matrix.ruby }}
-    runs-on: ubuntu-latest
+    name: ${{matrix.ruby}} on ${{matrix.os}}
+    runs-on: ${{matrix.os}}-latest
+    continue-on-error: ${{matrix.experimental}}
+    
     strategy:
-      fail-fast: false
       matrix:
-        ruby: ["3.3", "3.4", "4.0"]
+        os:
+          - ubuntu
+          - macos
+        
+        ruby:
+          - "3.3"
+          - "3.4"
+          - "4.0"
+        
+        experimental: [false]
+        
+        include:
+          - os: ubuntu
+            ruby: truffleruby
+            experimental: true
+          - os: ubuntu
+            ruby: jruby
+            experimental: true
+          - os: ubuntu
+            ruby: head
+            experimental: true
+    
     steps:
-      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
-      - uses: ruby/setup-ruby@a0102e0972be65f351c307e2d64b9314a57c8073 # v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run tests
-        timeout-minutes: 10
-        run: bundle exec sus-parallel
+    - uses: actions/checkout@v7
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+    
+    - name: Run tests
+      timeout-minutes: 10
+      run: bundle exec bake test

.gitignore

@@ -1,7 +1,12 @@
-/.bundle/
-/.context/
+/agents.md
+/.agents/
+/.bundle
+/pkg
+/gems.locked
 /.covered.db
+/external
+
+/.context/
 /coverage/
-/gems.locked
-/pkg/
 /vendor/bundle/
+/docs/