feat: enhance release notes formatting for Discord and Reddit, adding new rules and interactions

hannesrudolph · hannesrudolph · commit 5c4a3126eef5 · 2025-09-26T09:58:59.000-06:00
diff --git a/.roo/rules-release-notes-writer/1_main_workflow.xml b/.roo/rules-release-notes-writer/1_main_workflow.xml
@@ -1,7 +1,7 @@
 <workflow_instructions>
   <mode_overview>
     Automates creating release notes for new Roo Code versions. Fetches pull requests
-    from GitHub, analyzes changes, generates user-focused notes, and handles Discord
+    from GitHub, analyzes changes, generates user-focused notes, and handles Discord and Reddit
     formatting. Supports bare version requests (runs full workflow) and auto-detection of missing versions.
   </mode_overview>
 
@@ -26,6 +26,10 @@
       <trigger>latest</trigger>
       <action>Auto-detect missing versions from changelog</action>
     </pattern>
+  <pattern type="reddit_only">
+    <trigger>Reddit release notes for X.Y.Z</trigger>
+    <action>Generate Reddit format from existing files</action>
+  </pattern>
   </entry_patterns>
 
   <critical_date_format>
@@ -1870,7 +1874,7 @@ Which features should I highlight with expanded sections in the release notes?
 
   <special_workflows>
     <workflow name="discord_only">
-      <description>Generate Discord format from existing release files</description>
+      <description>Generate Discord format from existing release files and also produce Reddit variant</description>
       <transformations>
         - Remove PR links and numbers
         - Convert /path to https://docs.roocode.com/path
@@ -1941,6 +1945,10 @@ echo "]"
       </process>
       <handoff>After the user selects versions to process, use the simplified PR extraction for each selected version</handoff>
     </workflow>
+    <workflow name="reddit_only">
+      <description>Generate Reddit format from existing release files and also produce Discord variant</description>
+      <output>Formatted text (no files created)</output>
+    </workflow>
   </special_workflows>
 
   <simplified_pr_extraction_guide>
@@ -1989,5 +1997,8 @@ gh pr list --repo RooCodeInc/Roo-Code --state merged --base main --limit 1000 \
     <rule priority="HIGH">
       QOL Improvements section MUST come before Bug Fixes
     </rule>
+    <rule priority="HIGH">
+      When the user asks for Discord or Reddit notes, output both variants in a single response
+    </rule>
   </critical_rules>
 </workflow_instructions>
diff --git a/.roo/rules-release-notes-writer/2_content_standards.xml b/.roo/rules-release-notes-writer/2_content_standards.xml
@@ -247,113 +247,140 @@ Concluding sentence about the benefit.
 
   <discord_formatting>
     <overview>
-      Special formatting rules for Discord announcements to ensure readability
-      and engagement in chat format.
+      Special formatting rules for Discord announcements that reflect our latest house style and the final transformation flow.
     </overview>
 
     <structure>
       <element name="wrapper">
         <format>```markdown ... ```</format>
-        <description>Entire announcement wrapped in markdown code block</description>
+        <description>Wrap the entire announcement in a markdown code block</description>
       </element>
-      
+
       <element name="title">
-        <format># 🚀 Roo Code X.Y.Z Release Notes</format>
-        <format_combined># 🚀 Roo Code X.Y.Z-X.Y.Z Release Updates</format_combined>
+        <format># :rocket: Roo Code X.Y.Z Release Updates</format>
+        <format_combined># :rocket: Roo Code X.Y.Z-X.Y.Z Release Updates</format_combined>
         <rules>
-          - Always include rocket emoji
-          - Use "Release Notes" for single version
-          - Use "Release Updates" for combined versions
+          - Use :rocket: shortcode (not the emoji)
+          - Use "Release Updates" (not "Release Notes") for both single and combined versions
+          - For combined announcements, use "X.Y.Z-X.Y.Z" range formatting
         </rules>
       </element>
 
-      <element name="intro_sentence">
-        <format>We've shipped [updates/an update] with [feature summary]!</format>
+      <element name="tagline">
+        <format>@everyone [short hero summary]</format>
         <rules>
-          - Must summarize key features
-          - No marketing language ("powerful", "revolutionary")
-          - Be specific about what's included
+          - Discord only (omit from Reddit)
+          - Keep to a single concise line (e.g., "GPT‑5‑Codex tool‑usage fix, more FREE models on Roo Code Cloud and more!")
         </rules>
-        <examples>
-          <single>We've shipped an update with subtask todo lists, Vertex AI grounding, and performance improvements!</single>
-          <combined>We've shipped three updates with subtask todo lists, Vertex AI grounding features, Kimi K2 prompt caching, and the new Featherless provider!</combined>
-        </examples>
       </element>
 
       <element name="sections">
         <order>
-          1. ## ✨ Feature Highlights (not "Major Features")
-          2. ## 🎯 Provider Updates
-          3. ## 💪 QOL Improvements
-          4. ## 🐛 Bug Fixes
-          5. ## 🔧 Additional Improvements
+          1. ## Fixed: GPT-5-Codex errors and others!
+          2. ## Context condensing fix
+          3. ## More free models on Roo Code Cloud
+          4. ## More Changes
         </order>
         <rules>
-          - Use emojis for section headers
-          - "Feature Highlights" instead of "Major Features"
-          - Keep descriptions concise for chat readability
+          - No emojis in section headers
+          - In "Fixed: GPT-5-Codex...", copy the leading sentence EXACTLY from docs (include the PR link if present)
+          - Under that hero sentence, include the three bullets verbatim; render bullets as "- " hyphens
         </rules>
       </element>
 
-      <element name="compression_pattern">
-        <description>When user requests compression or content is too long</description>
-        <trigger>User says "compress" or "condense"</trigger>
-        <format><![CDATA[
-## 🔧 Other Improvements and Fixes
+      <element name="footer_blurb">
+        <format_single><![CDATA[
+See full release notes [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z)
+        ]]></format_single>
+        <format_combined><![CDATA[
+See full release notes [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z) | [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z)
+        ]]></format_combined>
+        <rules>
+          - Use markdown inline links with the version as the anchor text
+          - For multiple versions, join links with " | "
+        </rules>
+      </element>
+    </structure>
 
-These releases include [COUNT] improvements across bug fixes, provider updates, QOL enhancements, and misc updates. Thanks to [contributor1], [contributor2], [contributor3], and all other contributors who made these releases possible!
-        ]]></format>
+    <content_rules>
+      <rule priority="critical">No version numbers in body text (only header/footer)</rule>
+      <rule priority="critical">Never use marketing language</rule>
+      <rule priority="high">Retain PR link ONLY in the hero GPT‑5‑Codex section; remove PR links/numbers elsewhere</rule>
+      <rule priority="high">Convert any relative docs links to absolute https://docs.roocode.com paths</rule>
+      <rule priority="high">Use hyphen bullets ("- ") everywhere</rule>
+      <rule priority="medium">If long or on request, summarize remaining items into a single "More Changes" paragraph with contributor thanks and total change count</rule>
+    </content_rules>
+
+    <transformations>
+      <from>* </from>
+      <to>- </to>
+
+      <from>([#PR](link))</from>
+      <to>(remove everywhere except retain in the hero GPT‑5‑Codex section)</to>
+
+      <from>/path/to/page</from>
+      <to>https://docs.roocode.com/path/to/page</to>
+    </transformations>
+  </discord_formatting>
+
+  <reddit_formatting>
+    <overview>
+      Formatting for Reddit announcements, paired with Discord output by default.
+    </overview>
+
+    <structure>
+      <element name="wrapper">
+        <format>```markdown ... ```</format>
+        <description>Wrap the entire announcement in a markdown code block</description>
+      </element>
+      <element name="title">
+        <format>Roo Code X.Y.Z-X.Y.Z Release Updates | FREE models | GPT‑5‑Codex tool‑usage fix | More fixes!</format>
         <rules>
-          - Replace all sections below "Feature Highlights" with single paragraph
-          - Count actual number of improvements (not estimate)
-          - List specific contributor names from the releases
-          - Use "Other Improvements and Fixes" as section title
-          - Include all contributor acknowledgments in one place
+          - Plain text line (no leading "#")
+          - Include the three-part summary fragments as shown
         </rules>
-        <example><![CDATA[
-## 🔧 Other Improvements and Fixes
+      </element>
 
-These releases include 18 improvements across bug fixes, provider updates, QOL enhancements, and misc updates. Thanks to anguslees, DarinVerheijke, semidark, elianiva, and all other contributors who made these releases possible!
-        ]]></example>
+      <element name="intro_note">
+        <format>*In case you did not know, r/RooCode is a Free and Open Source VS Code AI Coding extension.*</format>
       </element>
 
-      <element name="footer">
-        <format_single>📚 **Full Release Notes** [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z)</format_single>
-        <format_combined>📚 **Full Release Notes** [vX.Y.Z](link) | [vX.Y.Z](link) | [vX.Y.Z](link)</format_combined>
+      <element name="sections">
+        <order>
+          1. ## More free models on Roo Code Cloud
+          2. ## Fixed: GPT-5-Codex errors and others!
+          3. ## Context condensing fix
+          4. ## More Changes
+        </order>
         <rules>
-          - Use book emoji
-          - Bold "Full Release Notes"
-          - Markdown link format with version as link text
-          - Pipe separator for multiple versions
+          - Wrap entire output in a markdown code block
+          - No @everyone line
+          - No emojis in section headers
+          - Use hyphen bullets ("- ")
+          - Remove PR links everywhere (including hero)
         </rules>
       </element>
+
+      <element name="footer_blurb">
+        <format_single><![CDATA[
+See full release notes [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z)
+        ]]></format_single>
+        <format_combined><![CDATA[
+See full release notes [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z) | [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z)
+        ]]></format_combined>
+      </element>
     </structure>
 
     <content_rules>
-      <rule priority="critical">No version numbers in body text (only header/footer)</rule>
-      <rule priority="critical">Never use the word "powerful" or similar marketing terms</rule>
+      <rule priority="critical">No version numbers in body text</rule>
       <rule priority="high">Remove all PR numbers and links</rule>
-      <rule priority="high">Keep contributor thanks but remove PR references</rule>
-      <rule priority="high">No closing phrases like "Happy coding!"</rule>
-      <rule priority="medium">Use bullet points (•) instead of asterisks (*)</rule>
-      <rule priority="medium">Group minor items if over 2000 characters</rule>
+      <rule priority="high">Use absolute docs links</rule>
+      <rule priority="high">Use hyphen bullets ("- ")</rule>
     </content_rules>
+  </reddit_formatting>
 
-    <transformations>
-      <from>([#PR](link))</from>
-      <to>(remove entirely)</to>
-      
-      <from>/path/to/feature</from>
-      <to>https://docs.roocode.com/path/to/feature</to>
-      
-      <from>## Major Features</from>
-      <to>## ✨ Feature Highlights</to>
-      
-      <from>* </from>
-      <to>• </to>
-      
-      <from>Happy coding! 🦘</from>
-      <to>(remove entirely)</to>
-    </transformations>
-  </discord_formatting>
+  <cross_posting>
+    <rule>When the user asks for Discord notes, also produce Reddit notes in the same response.</rule>
+    <rule>When the user asks for Reddit notes, also produce Discord notes in the same response.</rule>
+  </cross_posting>
 </content_standards>
diff --git a/.roo/rules-release-notes-writer/3_user_interactions.xml b/.roo/rules-release-notes-writer/3_user_interactions.xml
@@ -188,38 +188,57 @@ Which would you like to process?</question>
 
   <discord_format_interaction>
     <trigger>Discord release notes for X.Y.Z</trigger>
-    <options>
-      <single_version>Generate Discord format for one version</single_version>
-      <multiple_versions>Combine multiple versions</multiple_versions>
-      <compression>Compress minor items if over 2000 chars or on request</compression>
-    </options>
+    <behavior>
+      <rule>Immediately generate Discord and Reddit posts using social_formatting rules (no prompt).</rule>
+      <rule>Only ask if the user requests "compress"/"condense", or if content exceeds 2000 chars.</rule>
+    </behavior>
+    <formatting_checklist>
+      <item>Title uses ":rocket:" and "Release Updates" (single or X.Y.Z-X.Y.Z for combined)</item>
+      <item>Include "@everyone" tagline line with short hero summary under the title</item>
+      <item>Section order: Fixed: GPT-5-Codex errors and others!, Context condensing fix, More free models on Roo Code Cloud, More Changes</item>
+      <item>Use hyphen bullets "- " only; no emojis in section headers</item>
+      <item>Hero sentence for GPT-5-Codex copied EXACTLY from docs (preserve PR link); other sections remove PR links</item>
+      <item>Footer blurb: See full release notes [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z) (single) or [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z) | [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z) (combined)</item>
+      <item>Wrap entire output in ```markdown code block</item>
+    </formatting_checklist>
     <compression_workflow>
       <trigger>User says "compress", "condense", or content exceeds 2000 chars</trigger>
       <steps>
-        <step>Keep Feature Highlights section intact</step>
-        <step>Count all improvements below Feature Highlights</step>
-        <step>Replace all sections with single "Other Improvements and Fixes" paragraph</step>
-        <step>Include contributor acknowledgments in compressed section</step>
+        <step>Preserve the "Fixed: GPT-5-Codex..." section intact</step>
+        <step>Summarize remaining content into a single "More Changes" paragraph with total count and contributor thanks</step>
       </steps>
       <validation>
-        <item>Verify actual count of improvements (not estimate)</item>
-        <item>Ensure all contributors are acknowledged</item>
-        <item>Maintain markdown code block wrapper</item>
+        <item>Verify actual count of changes</item>
+        <item>Maintain markdown code block and hyphen bullets</item>
       </validation>
-    </compression_workflow>
-    <template><![CDATA[
+      <template><![CDATA[
 <ask_followup_question>
-<question>How would you like the Discord announcement formatted?</question>
+<question>The Discord post is long. Compress remaining sections into a single "More Changes" paragraph?</question>
 <follow_up>
-<suggest>Standard format with all details</suggest>
-<suggest>Compressed format (group minor items)</suggest>
-<suggest>Highlights only (major features)</suggest>
-<suggest>Multiple versions combined</suggest>
+<suggest>Yes, compress remaining sections</suggest>
+<suggest>No, keep full details</suggest>
 </follow_up>
 </ask_followup_question>
-    ]]></template>
+      ]]></template>
+    </compression_workflow>
   </discord_format_interaction>
 
+  <reddit_format_interaction>
+    <trigger>Reddit release notes for X.Y.Z</trigger>
+    <behavior>
+      <rule>Immediately generate Reddit and Discord posts using social_formatting rules (no prompt).</rule>
+    </behavior>
+    <formatting_checklist>
+      <item>Title (plain text): "Roo Code X.Y.Z-X.Y.Z Release Updates | FREE models | GPT‑5‑Codex tool‑usage fix | More fixes!"</item>
+      <item>Intro italic note present</item>
+      <item>Section order: More free models on Roo Code Cloud, Fixed: GPT-5-Codex errors and others!, Context condensing fix, More Changes</item>
+      <item>Use hyphen bullets "- " only; no emojis, no @everyone</item>
+      <item>Wrap entire output in ```markdown code block</item>
+      <item>Remove PR links everywhere</item>
+      <item>Footer blurb: See full release notes [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z) (single) or [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z) | [vX.Y.Z](https://docs.roocode.com/update-notes/vX.Y.Z) (combined)</item>
+    </formatting_checklist>
+  </reddit_format_interaction>
+
   <discord_combined_interaction>
     <trigger>Combined Discord announcement for multiple versions</trigger>
     <workflow>
@@ -229,23 +248,20 @@ Which would you like to process?</question>
       <step>Present formatted output in markdown code block</step>
     </workflow>
     <formatting_checklist>
-      <item>Title uses version range (X.Y.Z-X.Y.Z)</item>
-      <item>Intro sentence summarizes all versions</item>
-      <item>Features merged and deduplicated</item>
-      <item>No version numbers in body text</item>
-      <item>Footer has links to each version</item>
-      <item>Entire output wrapped in ```markdown block</item>
-      <item>No "Happy coding!" or similar closings</item>
-      <item>"Feature Highlights" not "Major Features"</item>
+      <item>Title uses ":rocket:" and version range (X.Y.Z-X.Y.Z) with "Release Updates"</item>
+      <item>Include "@everyone" tagline line with short hero summary</item>
+      <item>Section order: Fixed: GPT-5-Codex errors and others!, Context condensing fix, More free models on Roo Code Cloud, More Changes</item>
+      <item>Use hyphen bullets "- " only; no emojis in section headers</item>
+      <item>Hero sentence copied EXACTLY with PR link preserved</item>
+      <item>Footer links as hyphen bullets to each version's docs page</item>
+      <item>Wrap entire output in ```markdown code block</item>
     </formatting_checklist>
     <template><![CDATA[
 <ask_followup_question>
-<question>I'll create a combined Discord announcement for versions [list]. Should I:</question>
+<question>If the combined post is long, should I compress minor sections into a single "More Changes" paragraph?</question>
 <follow_up>
-<suggest>Include all features and changes from all versions</suggest>
-<suggest>Focus on major features only</suggest>
-<suggest>Group similar changes across versions</suggest>
-<suggest>Create separate announcements for each version</suggest>
+<suggest>Yes, compress if needed</suggest>
+<suggest>No, keep full details</suggest>
 </follow_up>
 </ask_followup_question>
     ]]></template>
