shaiwatcher/assets/docs/commands/UserCardsCog.usercards_rescan.details.html
Franz Rolfsvaag fdd336fe91 0.4.1.0.a1
- Doc site UI improvements and fixes
  - Added Discord widget
  - Fixed some styling issues
  - Added command docs briefs and details
    - Briefs are shown in the right-hand panel
    - Details can be shown by clicking `Open full details`
  - Added ShaiWatchers' logo as the site favicon
  - Moved HTML template to static file for responsiveness improvements
2025-08-15 06:17:52 +02:00

48 lines
2.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<h1>/usercards_rescan — Reconcile & refresh all cards</h1>
<p>One-shot maintenance pass that makes the servers user cards match reality.</p>
<h2>Access</h2>
<ul>
<li><strong>Moderator-only</strong> — requires the Discord permission <em>Manage Server</em>.</li>
<li>Must be used in a server channel (not DMs). The result is sent <em>ephemerally</em>.</li>
</ul>
<h2>What it fixes</h2>
<ol>
<li><strong>Rules / RoE agreement</strong>
<ul>
<liReads reactions from your configured Rules and RoE messages.</li>
<li>Adds/removes the corresponding roles so roles match the reactions.</li>
</ul>
</li>
<li><strong>Nickname claim &amp; reviews</strong>
<ul>
<li>If a member has an “accept” reaction on the Nickname message but has <em>no</em> pending/verified record and <em>no</em> open review, it opens a <em>pending nickname review</em> for them.</li>
<li>If a member <em>removed</em> their Nickname reaction, it clears any pending/verified state.</li>
</ul>
</li>
<li><strong>User cards</strong>
<ul>
<li>Updates (or recreates) the embed for each member in the configured “users list” channel.</li>
<li>Card color reflects: Rules, RoE, and Nickname status (✅ verified / ✔️ pending / ❌ not done).</li>
<li>Uses a stable footer marker (<code>UID:&lt;id&gt;</code>) to find/edit the right card; cleans up duplicates.</li>
</ul>
</li>
</ol>
<h2>Expected output</h2>
<p>The command replies (ephemeral) with counts like:</p>
<pre>Reconciled from messages. Changes — Rules: 3, RoE: 2, Nickname (added): 1, Nickname (removed): 0. Refreshed cards for 154 members.</pre>
<h2>Setup notes</h2>
<ul>
<li>Relies on your configured IDs (ENV/INI): Rules/RoE/Nickname message IDs and their role IDs, the Full Access role, the user-cards channel, and the mod/modlog channels.</li>
<li>Wont ping anyone; all posts/edits are sent with <em>no mentions</em>.</li>
</ul>
<h2>Tips</h2>
<ul>
<li>Run after importing a server, restoring from backup, or after downtime.</li>
<li>Large servers: this may take a moment while it walks members and edits cards. Its safe to run again.</li>
</ul>