docs: add website (#582)

* docs: add website

* fix: docs only mode

* fix: fix

* fix: fix

* fix: fix

Author: janicduplessis

.github/workflows/android.yml

@@ -13,17 +13,18 @@ on:
     paths:
       - '.github/workflows/android.yml'
       - 'android/**'
+      - 'common/**'
       - 'example/android/**'
 
 jobs:
   android-build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 18.x
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
       - uses: actions/setup-java@v2
         with:
           distribution: 'temurin'
@@ -47,11 +48,11 @@ jobs:
   android-build-fabric:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 18.x
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
         uses: actions/setup-node@v1
         with:
-          node-version: 18.x
+          node-version: 20.x
       - uses: actions/setup-java@v2
         with:
           distribution: 'temurin'

.github/workflows/docs-check.yml

@@ -0,0 +1,32 @@
+name: Docs build check
+env:
+  YARN_ENABLE_HARDENED_MODE: 0
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/workflows/docs-check.yml'
+      - docs/**
+  pull_request:
+    paths:
+      - '.github/workflows/docs-check.yml'
+      - docs/**
+jobs:
+  build:
+    if: github.repository == 'AppAndFlow/react-native-safe-area-context'
+    runs-on: ubuntu-latest
+    env:
+      WORKING_DIRECTORY: docs
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: Install docs deps
+        working-directory: ${{ env.WORKING_DIRECTORY }}
+        run: yarn install
+      - name: Build docs
+        working-directory: ${{ env.WORKING_DIRECTORY }}
+        run: yarn build

.github/workflows/docs-deploy.yml

@@ -0,0 +1,30 @@
+name: Docs publish
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - docs/**
+
+jobs:
+  publish:
+    if: github.repository == 'AppAndFlow/react-native-safe-area-context'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Generate awesome content
+        run: >-
+          git config --local user.email "action@github.com"
+          && git config --local user.name "GitHub Action"
+          && cd docs
+          && yarn
+          && yarn build
+
+      - name: Publish generated content to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          FOLDER: docs/build
+          BRANCH: gh-pages
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ios.yml

@@ -19,11 +19,11 @@ jobs:
   ios-build:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 18.x
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
@@ -43,11 +43,11 @@ jobs:
   ios-build-fabric:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 18.x
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
         uses: actions/setup-node@v1
         with:
-          node-version: 18.x
+          node-version: 20.x
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7

.github/workflows/js.yml

@@ -6,11 +6,11 @@ jobs:
   js-tests:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 18.x
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: 20.x
       - name: Restore yarn workspaces
         id: yarn-cache
         uses: actions/cache@v3

CONTRIBUTING.md

@@ -1,61 +1,3 @@
 # Contributing
 
-## Development workflow
-
-### Install dependencies
-
-Use yarn to install development dependencies.
-
-```sh
-yarn install
-```
-
-If you don't have bundler installed:
-
-```
-gem install bundler
-```
-
-Move to the `example` directory and install dependencies there too.
-
-```sh
-cd example
-yarn install
-bundle install
-```
-
-```sh
-cd ios && bundle exec pod install
-```
-
-### Example app
-
-Start the example app to test your changes. You can use one of the following commands from the repo root, depending on the platform you want to use.
-
-From the `example` directory:
-
-#### iOS
-
-```sh
-yarn ios
-```
-
-I also recommend opening `example/ios/SafeAreaViewExample.xcworkspace` in Xcode if you need to make changes to native code.
-
-#### Android
-
-```sh
-yarn android
-```
-
-I also recommend opening `example/android` in Android Studio if you need to make changes to native code.
-
-Use `ctrl+cmd+z` on iOS or `ctrl+m` on Android to open the dev menu and choose an example.
-
-### Run tests
-
-```sh
-yarn test
-```
-
-### Open a pull request!
+See https://appandflow.github.io/react-native-safe-area-context/contributing/