Skip to content

Commit c4e29dc

Browse files
Add validation cohesion checking and enhance release notes workflow (#282)
1 parent 2045733 commit c4e29dc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2675
-635
lines changed

.roo/rules-docs/1_writing_style.xml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@
33
This guide defines the writing style for Roo Code documentation. The style is direct, concise, and technical. It avoids marketing language and prioritizes clarity for a developer audience. All output must be in markdown.
44
</overview>
55

6+
<discovery_principle>
7+
<rule>Before writing or editing documentation, always explore existing documentation to understand established patterns, style, and structure.</rule>
8+
<steps>
9+
<step>Use list_files to explore the documentation structure</step>
10+
<step>Read similar existing documents to understand the style</step>
11+
<step>Follow established patterns rather than imposing new ones</step>
12+
</steps>
13+
</discovery_principle>
14+
615
<core_principles>
716
<principle name="directness">
817
<rule>Start with the most important information. No filler introductions.</rule>
@@ -17,11 +26,17 @@
1726
</principle>
1827
<principle name="consistency">
1928
<rule>When editing a document, use its existing style, structure, and format as a guideline for any updates. Do not make major changes unless explicitly asked.</rule>
29+
<discovery_approach>
30+
<step>Read the entire document first to understand its current style</step>
31+
<step>Identify patterns in headings, formatting, and tone</step>
32+
<step>Match the existing style in your edits</step>
33+
</discovery_approach>
2034
</principle>
2135
</core_principles>
2236

2337
<banned_language>
2438
<description>Avoid marketing jargon, buzzwords, and clichés. These words are ambiguous and reduce signal.</description>
39+
<discovery_note>When editing existing documentation, check if any of these words are already used and maintain consistency with the existing approach.</discovery_note>
2540
<words>
2641
<word>seamlessly</word>
2742
<word>comprehensive</word>
@@ -42,5 +57,21 @@
4257
<guideline>Use structured headings, lists, and short paragraphs for scannability.</guideline>
4358
<guideline>Provide clear, copy-pasteable code snippets.</guideline>
4459
<guideline>Assume user familiarity with basic concepts. Do not over-explain.</guideline>
60+
<discovery_approach>
61+
<step>Before formatting new content, examine existing documentation for:
62+
- Heading hierarchy patterns (H1, H2, H3 usage)
63+
- List formatting preferences (bullets vs numbers)
64+
- Code block styling and language tags
65+
- Paragraph length and structure
66+
</step>
67+
<step>Match the discovered patterns to maintain consistency</step>
68+
</discovery_approach>
4569
</formatting>
70+
71+
<before_writing_checklist>
72+
<item>Have I explored the existing documentation structure?</item>
73+
<item>Have I read similar documents to understand the established style?</item>
74+
<item>Have I identified the patterns for paths, links, and references?</item>
75+
<item>Am I following discovered patterns rather than making assumptions?</item>
76+
</before_writing_checklist>
4677
</writing_style_guide>

.roo/rules-docs/2_docusaurus_conventions.xml

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,43 @@
11
<docusaurus_conventions>
22
<overview>
3-
This guide covers Docusaurus-specific formatting rules for Roo Code documentation.
3+
This guide covers Docusaurus-specific formatting rules for Roo Code documentation. Before applying these conventions, always explore the project structure to understand the actual directory layout.
44
</overview>
55

6+
<discovery_first>
7+
<principle>Always use list_files to discover the actual project structure before making assumptions about paths</principle>
8+
<principle>Check for existing patterns in similar files before creating new content</principle>
9+
<principle>Verify directory existence before referencing specific paths</principle>
10+
</discovery_first>
11+
612
<linking>
713
<rule name="internal_links">
8-
<description>Use absolute paths from `/docs/`. Do not include the `.md` extension.</description>
14+
<description>Use paths relative to the documentation root. Do not include the `.md` extension. Discover the documentation structure first.</description>
15+
<discovery_steps>
16+
<step>Use list_files to find the documentation root directory</step>
17+
<step>Identify the path structure used in existing documentation</step>
18+
<step>Follow the established pattern</step>
19+
</discovery_steps>
920
<good>[Link to Guide](/intro/)</good>
1021
<bad>[Link to Guide](../intro.md)</bad>
1122
</rule>
1223
<rule name="site_alias">
1324
<description>Use `@site` for code imports or asset references from the project root. Do not use it for Markdown links.</description>
14-
<good>import Header from \'@site/src/components/Header\';</good>
25+
<good>import Header from '@site/src/components/Header';</good>
1526
<bad>[Link](@site/docs/intro.md)</bad>
1627
</rule>
1728
</linking>
1829

1930
<media>
2031
<rule name="images">
21-
<description>Place images in `/static/img/`. Use a relative path in `src`.</description>
32+
<description>Discover the image storage location in the project before placing images. Look for existing image references to understand the pattern.</description>
33+
<discovery_steps>
34+
<step>Use list_files to find where images are stored (commonly in static/img or similar)</step>
35+
<step>Check existing documentation for image reference patterns</step>
36+
<step>Follow the established convention</step>
37+
</discovery_steps>
2238
<example>
2339
<![CDATA[
40+
<!-- First discover the actual image path structure, then use it -->
2441
<img src="/img/installing/installing-2.png" alt="VS Code's Install from VSIX dialog" width="600" />
2542
]]>
2643
</example>
@@ -29,12 +46,23 @@
2946

3047
<versioning>
3148
<rule name="no_version_numbers">
32-
<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>
49+
<description>Do not include version numbers or phrases like "as of version X.Y" in general documentation. First discover where version information is stored in the project.</description>
50+
<discovery_steps>
51+
<step>Use list_files to find version-related documentation directories</step>
52+
<step>Check for patterns like update-notes, changelog, or release directories</step>
53+
<step>Place version-specific information in the appropriate location</step>
54+
</discovery_steps>
3355
</rule>
3456
</versioning>
57+
3558
<frontmatter>
3659
<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>
60+
<description>Check existing documentation files for frontmatter patterns before adding new ones. The required fields may vary by project.</description>
61+
<discovery_steps>
62+
<step>Read several existing documentation files to understand the frontmatter pattern</step>
63+
<step>Identify which fields are consistently used</step>
64+
<step>Follow the established pattern</step>
65+
</discovery_steps>
3866
<example>
3967
<![CDATA[
4068
---
@@ -50,4 +78,12 @@ image: /img/social-share.jpg
5078
</example>
5179
</rule>
5280
</frontmatter>
81+
82+
<general_discovery_workflow>
83+
<step number="1">Use list_files to explore the project structure</step>
84+
<step number="2">Read existing files similar to what you're creating/editing</step>
85+
<step number="3">Identify patterns in paths, formatting, and conventions</step>
86+
<step number="4">Follow the established patterns rather than assuming standard locations</step>
87+
<step number="5">When in doubt, ask for clarification rather than making assumptions</step>
88+
</general_discovery_workflow>
5389
</docusaurus_conventions>

0 commit comments

Comments
 (0)