Merge pull request #346 from okp4/docs/overview-section

Docs/overview section

.github/workflows/capture-website.yml

@@ -0,0 +1,54 @@
+name: Capture website
+
+on:
+  workflow_dispatch:
+
+  schedule:
+    - cron: "0 0 * * 0"
+
+concurrency:
+  group: capture-website-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  capture-website:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.OKP4_TOKEN }}
+
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v6
+        with:
+          gpg_private_key: ${{ secrets.OKP4_BOT_GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.OKP4_BOT_GPG_PASSPHRASE }}
+          git_config_global: true
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+
+      - name: Setup node environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.12
+          cache: npm
+
+      - name: Screenshot Website
+        run: |
+          npx [email protected] \
+            --type webp \
+            --quality=0.7 \
+            --launch-options='{"headless": "new"}' \
+            --output screenshot.webp \
+            --overwrite \
+            --dark-mode \
+            https://docs.okp4.network/
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_user_name: ${{ secrets.OKP4_BOT_GIT_COMMITTER_NAME }}
+          commit_user_email: ${{ secrets.OKP4_BOT_GIT_COMMITTER_EMAIL }}
+          commit_author: ${{ secrets.OKP4_BOT_GIT_AUTHOR_NAME }} <${{ secrets.OKP4_BOT_GIT_AUTHOR_EMAIL }}>
+          commit_message: "docs: update website screenshot"

README.md

@@ -11,6 +11,12 @@
 [![license][bsd-3-clause-image]][bsd-3-clause]
 [![cc-by-sa-4.0][cc-by-sa-image]][cc-by-sa]
 
+## Overview
+
+This repository contains the source code for the OKP4 documentation portal, which is hosted at <https://docs.okp4.network>.
+
+![[docs.okp4.network](https://docs.okp4.network)](./screenshot.webp)
+
 ## Developing & contributing
 
 ### Installation