From e89f4ca1097b88278d56af010ad6544ed7713112 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20Schr=C3=B6er?= <code@sweikenb.com>
Date: Fri, 29 Sep 2023 23:21:27 +0200
Subject: [PATCH] gh docs scaffolding

---
 README.md                              |  2 +-
 docs/src/SUMMARY.md                    | 32 +++++++++++++++++++++++++-
 docs/src/chapter_1.md                  |  1 -
 docs/src/examples/async-workloads.md   |  1 +
 docs/src/examples/ipc-examples.md      |  1 +
 docs/src/examples/queued-processing.md |  1 +
 docs/src/features/ipc.md               |  1 +
 docs/src/features/process-manager.md   |  1 +
 docs/src/features/process-queue.md     |  1 +
 9 files changed, 38 insertions(+), 3 deletions(-)
 delete mode 100644 docs/src/chapter_1.md
 create mode 100644 docs/src/examples/async-workloads.md
 create mode 100644 docs/src/examples/ipc-examples.md
 create mode 100644 docs/src/examples/queued-processing.md
 create mode 100644 docs/src/features/ipc.md
 create mode 100644 docs/src/features/process-manager.md
 create mode 100644 docs/src/features/process-queue.md

diff --git a/README.md b/README.md
index 527a840..659b8f2 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Simple and easy to use thread-based process manager for PHP based on default PCN
 
 **Further information:**
 
-- [Docs](docs/index.md)
+- [Docs](https://sweikenb.github.io/pcntl/)
 - [Changelog](CHANGELOG.md)
 - [MIT License](LICENSE.txt)
 
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
index 7390c82..7a22841 100644
--- a/docs/src/SUMMARY.md
+++ b/docs/src/SUMMARY.md
@@ -1,3 +1,33 @@
 # Summary
 
-- [Chapter 1](./chapter_1.md)
+# Installation
+
+Install the latest version using [composer](https://getcomposer.org/):
+
+```bash
+composer require sweikenb/pcntl
+```
+
+## System Requirements
+
+This library requires at least **PHP v8.2** with the following extensions enabled:
+
+- `pcntl`
+- `posix`
+- `sockets`
+
+Note that this library is **incompatible** with the `grpc` extension!
+
+In order to execute the unit-tests you will need to run them in a linux environment.
+
+# Features
+
+- [Process Manager](features/process-manager.md)
+- [Process Queue](features/process-queue.md)
+- [Inter Process Communication (IPC)](features/ipc.md)
+
+# Examples
+
+- [Async Workloads](examples/async-workloads.md)
+- [Queued Parallel-Processing](examples/queued-processing.md)
+- [IPC Examples](examples/ipc-examples.md)
diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md
deleted file mode 100644
index b743fda..0000000
--- a/docs/src/chapter_1.md
+++ /dev/null
@@ -1 +0,0 @@
-# Chapter 1
diff --git a/docs/src/examples/async-workloads.md b/docs/src/examples/async-workloads.md
new file mode 100644
index 0000000..34322c4
--- /dev/null
+++ b/docs/src/examples/async-workloads.md
@@ -0,0 +1 @@
+# Async Workloads
diff --git a/docs/src/examples/ipc-examples.md b/docs/src/examples/ipc-examples.md
new file mode 100644
index 0000000..7e18adf
--- /dev/null
+++ b/docs/src/examples/ipc-examples.md
@@ -0,0 +1 @@
+# IPC Examples
diff --git a/docs/src/examples/queued-processing.md b/docs/src/examples/queued-processing.md
new file mode 100644
index 0000000..966acbb
--- /dev/null
+++ b/docs/src/examples/queued-processing.md
@@ -0,0 +1 @@
+# Queued Processing
diff --git a/docs/src/features/ipc.md b/docs/src/features/ipc.md
new file mode 100644
index 0000000..30d01d1
--- /dev/null
+++ b/docs/src/features/ipc.md
@@ -0,0 +1 @@
+# Inter Process Communication (IPC)
diff --git a/docs/src/features/process-manager.md b/docs/src/features/process-manager.md
new file mode 100644
index 0000000..88b58a7
--- /dev/null
+++ b/docs/src/features/process-manager.md
@@ -0,0 +1 @@
+# Process Manager
diff --git a/docs/src/features/process-queue.md b/docs/src/features/process-queue.md
new file mode 100644
index 0000000..45096c1
--- /dev/null
+++ b/docs/src/features/process-queue.md
@@ -0,0 +1 @@
+# Process Queue