From e020f1f0260b1aaa9f5731b4067eeb1ccb7ef50e Mon Sep 17 00:00:00 2001
From: orion <orion@op.hangman-lab.top>
Date: Wed, 25 Feb 2026 10:37:12 +0000
Subject: [PATCH] docs: add sample config and verification guide

---
 docs/CONFIG.example.json | 28 ++++++++++++++++++++++++++++
 docs/VERIFY.md           | 30 ++++++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 docs/CONFIG.example.json
 create mode 100644 docs/VERIFY.md

diff --git a/docs/CONFIG.example.json b/docs/CONFIG.example.json
new file mode 100644
index 0000000..0eb1a80
--- /dev/null
+++ b/docs/CONFIG.example.json
@@ -0,0 +1,28 @@
+{
+  "plugins": {
+    "load": {
+      "paths": ["/path/to/WhisperGate/plugin"]
+    },
+    "entries": {
+      "whispergate": {
+        "enabled": true,
+        "config": {
+          "enabled": true,
+          "discordOnly": true,
+          "bypassUserIds": ["561921120408698910"],
+          "endSymbols": ["。", "！", "？", ".", "!", "?"],
+          "noReplyProvider": "openai",
+          "noReplyModel": "whispergate-no-reply-v1"
+        }
+      }
+    }
+  },
+  "models": {
+    "providers": {
+      "openai": {
+        "apiKey": "sk-xxxx",
+        "baseURL": "http://127.0.0.1:8787/v1"
+      }
+    }
+  }
+}
diff --git a/docs/VERIFY.md b/docs/VERIFY.md
new file mode 100644
index 0000000..6375c48
--- /dev/null
+++ b/docs/VERIFY.md
@@ -0,0 +1,30 @@
+# WhisperGate Quick Verification
+
+## 1) Start no-reply API
+
+```bash
+cd no-reply-api
+npm start
+```
+
+## 2) Validate API behavior
+
+```bash
+curl -sS http://127.0.0.1:8787/health
+curl -sS -X POST http://127.0.0.1:8787/v1/chat/completions \
+  -H 'Content-Type: application/json' \
+  -d '{"model":"whispergate-no-reply-v1","messages":[{"role":"user","content":"hi"}]}'
+```
+
+Expected assistant text: `NO_REPLY`
+
+## 3) Enable plugin
+
+Set OpenClaw plugin path to `plugin/` and apply `docs/CONFIG.example.json` values.
+
+## 4) Discord logic check
+
+- non-discord session -> normal model
+- discord + bypass user -> normal model
+- discord + non-bypass + ending punctuation -> normal model
+- discord + non-bypass + no ending punctuation -> no-reply model override