Skip to content

Commit 21a5188

Browse files
committed
Add frontmatter requirements to docs and release notes
Introduces rules requiring frontmatter with description, keywords, and a social share image for all documentation and release notes. Updates examples and formatting standards to reflect this new requirement.
1 parent 6e76024 commit 21a5188

File tree

3 files changed

+42
-21
lines changed

3 files changed

+42
-21
lines changed

.roo/rules-docs/2_docusaurus_conventions.xml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,22 @@
3232
<description>Do not include version numbers or phrases like "as of version X.Y" in general documentation. Version information belongs only in `docs/update-notes`.</description>
3333
</rule>
3434
</versioning>
35+
<frontmatter>
36+
<rule name="metadata">
37+
<description>All pages must include frontmatter with description, keywords, and a social share image. The title will be automatically generated from the first H1 heading.</description>
38+
<example>
39+
<![CDATA[
40+
---
41+
description: A concise summary of the page content.
42+
keywords:
43+
- relevant
44+
- keywords
45+
- for
46+
- search
47+
image: /img/social-share.jpg
48+
---
49+
]]>
50+
</example>
51+
</rule>
52+
</frontmatter>
3553
</docusaurus_conventions>

.roo/rules-release-notes-writer/2_formatting_standards.xml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,21 @@
1919
</file_naming_conventions>
2020

2121
<file_structure>
22+
<element name="frontmatter">
23+
<description>All release notes must include frontmatter with a description, keywords, and a social share image. The title is generated automatically from the first H1 heading.</description>
24+
<example>
25+
<![CDATA[
26+
---
27+
description: A concise summary of the release.
28+
keywords:
29+
- roo code x.y.z
30+
- new features
31+
- bug fixes
32+
image: /img/social-share.jpg
33+
---
34+
]]>
35+
</example>
36+
</element>
2237
<element name="title">
2338
<format># Roo Code X.Y.Z Release Notes (YYYY-MM-DD)</format>
2439
<requirements>

.roo/rules-release-notes-writer/5_complete_example.xml

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,14 @@ Use update_todo_list to track your progress through these steps.
138138
<write_to_file>
139139
<path>docs/update-notes/v3.20.3.mdx</path>
140140
<content>
141+
---
142+
description: This release improves reliability and fixes large file handling.
143+
keywords:
144+
- roo code 3.20.3
145+
- reliability
146+
- large file handling
147+
image: /img/social-share.jpg
148+
---
141149
# Roo Code 3.20.3 Release Notes (2025-01-13)
142150
143151
This release improves reliability and fixes large file handling.
@@ -149,24 +157,4 @@ This release improves reliability and fixes large file handling.
149157
150158
## Provider Updates
151159
152-
* **OpenAI**: Added support for new GPT-4 models (thanks provider-dev!) ([#1236](link))
153-
</content>
154-
<line_count>11</line_count>
155-
</write_to_file>
156-
]]></tool_use>
157-
<note>Acknowledgments include PR author and issue reporter where applicable.</note>
158-
</step>
159-
</workflow>
160-
161-
<key_improvements>
162-
<improvement>
163-
<description>Subtask-based processing organizes the workflow and isolates errors.</description>
164-
</improvement>
165-
<improvement>
166-
<description>Workflow extracts linked issues to acknowledge all contributors.</description>
167-
</improvement>
168-
<improvement>
169-
<description>Subtasks write findings to a temp file, ensuring no data loss.</description>
170-
</improvement>
171-
</key_improvements>
172-
</complete_example>
160+
* **OpenAI**: Added support for new GPT-4 models (thanks provider-dev!) ([#1236](link))

0 commit comments

Comments
 (0)