Updates pending full V1 release

2026-03-10 18:37:11 +00:00
parent 3e5a330929
commit 9719a9b5f9
7 changed files with 230 additions and 75 deletions
@@ -0,0 +1,82 @@
+# ModReplyBot Moderator Guide
+
+## Wiki Configuration Page
+
+All bot configuration is managed via your subreddit wiki page. The page name is set by the `REDDIT_WIKI_PAGE` environment variable (default: `modreplybot-config`).
+
+**Always use the old.reddit.com wiki link for editing and referencing your config:**
+
+```
+https://old.reddit.com/r/<your_subreddit>/wiki/<wiki_page>
+```
+
+## Triggers
+
+Triggers allow moderators to perform bot actions by commenting with a trigger phrase or by reporting a post with a trigger phrase in the report reason. Triggers must start with a `!` (ex: `!help`).
+
+### Example Trigger Configuration
+```
+triggers:
+  - trigger: help
+    comment: |
+      Thank you for your report!
+      This post is now approved.
+    status: enabled
+  - trigger: wc
+    comment: |
+      Welcome to the community!
+    status: log-only
+```
+
+- **trigger**: The phrase (without the `!`) that mods use in comments or report reasons.
+- **comment**: The text the bot will post as a stickied comment.
+- **status**:
+  - `enabled`: Bot will approve the post and comment.
+  - `log-only`: Bot will approve the post but not comment.
+  - `disabled`: Bot will not act on this trigger.
+
+## Auto-Post Tags
+
+Auto-post tags allow the bot to comment automatically on new posts with specific tags in the title.
+
+### Example Auto-Post Tag Configuration
+```
+post_tags:
+  - tag: Bedrock, Java
+    comment: |
+      __[Click here if your post says "Sorry, this post was removed by Reddit’s filters"](...)__
+    status: enabled
+```
+
+- **tag**: Comma-separated list of tags. The bot matches tags in post titles (case-insensitive).
+- **comment**: The text the bot will post as a stickied comment.
+- **status**:
+  - `enabled`: Bot will comment automatically.
+  - `log-only`: Bot will log but not comment.
+  - `disabled`: Bot will not act on this tag.
+
+## Additional Notes
+- The bot only comments once per trigger per post (even if triggered multiple times).
+- The bot only auto-comments once per post for each tag.
+- All bot actions are logged for transparency.
+- If the wiki config is invalid, the bot will notify mods via modmail and pause until fixed.
+
+## Troubleshooting
+- Make sure your wiki config is valid YAML and includes both `triggers` and `post_tags` sections.
+- Use old.reddit.com for wiki editing to avoid formatting issues.
+- Check bot logs for errors and modmail for config issues.
+
+## Example Wiki Config Excerpt
+```
+triggers:
+  - trigger: help
+    comment: |
+      Thank you for your report!
+      This post is now approved.
+    status: enabled
+post_tags:
+  - tag: Bedrock, Java
+    comment: |
+      __[Click here if your post says "Sorry, this post was removed by Reddit’s filters"](...)__
+    status: enabled
+```