You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .roo/rules-docs/1_writing_style.xml
+31Lines changed: 31 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,15 @@
3
3
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.
4
4
</overview>
5
5
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
+
6
15
<core_principles>
7
16
<principlename="directness">
8
17
<rule>Start with the most important information. No filler introductions.</rule>
@@ -17,11 +26,17 @@
17
26
</principle>
18
27
<principlename="consistency">
19
28
<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>
20
34
</principle>
21
35
</core_principles>
22
36
23
37
<banned_language>
24
38
<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>
25
40
<words>
26
41
<word>seamlessly</word>
27
42
<word>comprehensive</word>
@@ -42,5 +57,21 @@
42
57
<guideline>Use structured headings, lists, and short paragraphs for scannability.</guideline>
Copy file name to clipboardExpand all lines: .roo/rules-docs/2_docusaurus_conventions.xml
+42-6Lines changed: 42 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,43 @@
1
1
<docusaurus_conventions>
2
2
<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.
4
4
</overview>
5
5
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
+
6
12
<linking>
7
13
<rulename="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>
9
20
<good>[Link to Guide](/intro/)</good>
10
21
<bad>[Link to Guide](../intro.md)</bad>
11
22
</rule>
12
23
<rulename="site_alias">
13
24
<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>
15
26
<bad>[Link](@site/docs/intro.md)</bad>
16
27
</rule>
17
28
</linking>
18
29
19
30
<media>
20
31
<rulename="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>
22
38
<example>
23
39
<![CDATA[
40
+
<!-- First discover the actual image path structure, then use it -->
24
41
<img src="/img/installing/installing-2.png" alt="VS Code's Install from VSIX dialog" width="600" />
25
42
]]>
26
43
</example>
@@ -29,12 +46,23 @@
29
46
30
47
<versioning>
31
48
<rulename="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>
33
55
</rule>
34
56
</versioning>
57
+
35
58
<frontmatter>
36
59
<rulename="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>
38
66
<example>
39
67
<![CDATA[
40
68
---
@@ -50,4 +78,12 @@ image: /img/social-share.jpg
50
78
</example>
51
79
</rule>
52
80
</frontmatter>
81
+
82
+
<general_discovery_workflow>
83
+
<stepnumber="1">Use list_files to explore the project structure</step>
84
+
<stepnumber="2">Read existing files similar to what you're creating/editing</step>
85
+
<stepnumber="3">Identify patterns in paths, formatting, and conventions</step>
86
+
<stepnumber="4">Follow the established patterns rather than assuming standard locations</step>
87
+
<stepnumber="5">When in doubt, ask for clarification rather than making assumptions</step>
0 commit comments