Skip to content

Commit 120dbb6

Browse files
daniel-lxsPeterDaveHello
daniel-lxs
authored and
PeterDaveHello
committed
fix: strip unsupported JSON Schema format values for OpenAI compatibility (RooCodeInc#10198)
1 parent 6f65a26 commit 120dbb6

195 files changed

Lines changed: 34318 additions & 0 deletions

File tree

Some content is hidden

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

‎.roo/rules-docs-extractor/2_documentation_patterns.xml‎

Lines changed: 357 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,357 @@
1+
<documentation_patterns>
2+
<overview>
3+
Standard templates for structuring extracted documentation.
4+
</overview>
5+
6+
<output_structure>
7+
<user_focused_template>
8+
# [Feature Name]
9+
10+
[Description of what the feature does and why a user should care.]
11+
12+
### Key Features
13+
- [Benefit-oriented feature 1]
14+
- [Benefit-oriented feature 2]
15+
- [Benefit-oriented feature 3]
16+
17+
---
18+
19+
## Use Case
20+
21+
**Before**: [Description of the old way]
22+
- [Pain point 1]
23+
- [Pain point 2]
24+
25+
**With this feature**: [Description of the new experience.]
26+
27+
## How it Works
28+
29+
[Simple explanation of the feature's operation.]
30+
31+
[Suggest visual representations where helpful.]
32+
33+
---
34+
35+
## Configuration
36+
37+
[Explanation of relevant settings.]
38+
39+
1. **[Setting Name]**:
40+
- **Setting**: `[technical_name]`
41+
- **Description**: [What this does.]
42+
- **Default**: [Default value and its meaning.]
43+
44+
2. **[Setting Name]**:
45+
- **Setting**: `[technical_name]`
46+
- **Description**: [What this does.]
47+
- **Default**: [Default value and its meaning.]
48+
49+
---
50+
51+
## FAQ
52+
53+
**"[User question]"**
54+
- [Answer.]
55+
- [Optional tip.]
56+
57+
**"[User question]"**
58+
- [Answer.]
59+
- [Optional tip.]
60+
61+
</user_focused_template>
62+
63+
<comprehensive_template>
64+
# [Feature Name] Technical Documentation
65+
66+
## Table of Contents
67+
1. Overview
68+
2. Quick Start
69+
3. Architecture
70+
4. API Reference
71+
5. Configuration
72+
6. User Guide
73+
7. Developer Guide
74+
8. Security
75+
9. Performance
76+
10. Troubleshooting
77+
11. FAQ
78+
12. Changelog
79+
13. References
80+
81+
[Use this as an internal source-material outline for technical sections; not for final docs.]
82+
</comprehensive_template>
83+
</output_structure>
84+
85+
<documentation_patterns>
86+
<before_after>
87+
<template>
88+
**Before**: Multiple, sequential file read requests:
89+
- "Read `src/app.js`?" → Approve
90+
- "Read `src/utils.js`?" → Approve
91+
- "Read `src/config.json`?" → Approve
92+
93+
**Now**: One request to read all related files.
94+
</template>
95+
</before_after>
96+
97+
<visual_separator>
98+
<format>---</format>
99+
<purpose>Separate sections.</purpose>
100+
</visual_separator>
101+
102+
<faq>
103+
<template>
104+
## FAQ
105+
106+
**"Why disable this?"**
107+
- Your AI model handles single files better.
108+
- You need more control over file access.
109+
- You are working with very large files.
110+
111+
**"What if some files are blocked?"**
112+
- Roo reads approved files and works with what it has.
113+
- `.rooignore` files are excluded automatically.
114+
- Individual files can still be denied in the batch dialog.
115+
</template>
116+
</faq>
117+
118+
<examples>
119+
<guideline>Show tool output or UI elements.</guideline>
120+
<guideline>Use actual file paths and setting names.</guideline>
121+
<guideline>Include common errors and solutions.</guideline>
122+
</examples>
123+
124+
<troubleshooting>
125+
<template>
126+
## Troubleshooting
127+
128+
**"Too many files requested"**
129+
- Lower the concurrent file limit in settings.
130+
- Deny individual files in the batch dialog.
131+
132+
**"Feature isn't working"**
133+
- Ensure "Enable concurrent file reads" is on in settings.
134+
- Verify the file limit is set correctly (default: 100).
135+
- Some AI models may not support this feature.
136+
</template>
137+
</troubleshooting>
138+
139+
<help>
140+
<template>
141+
## Help
142+
143+
- See the [FAQ](#faq) for common issues.
144+
- Report problems on [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues).
145+
- Include reproduction steps and error messages.
146+
</template>
147+
</help>
148+
</documentation_patterns>
149+
150+
<audience_sections>
151+
<audience type="user">
152+
<focus>
153+
<area>Tutorials</area>
154+
<area>Use cases</area>
155+
<area>Troubleshooting</area>
156+
<area>Benefits</area>
157+
</focus>
158+
<style>
159+
<guideline>Simple language</guideline>
160+
<guideline>Visual aids</guideline>
161+
<guideline>Focus on outcomes</guideline>
162+
<guideline>Clear action steps</guideline>
163+
</style>
164+
</audience>
165+
166+
<audience type="developer">
167+
<focus>
168+
<area>Code examples</area>
169+
<area>API specs</area>
170+
<area>Integration patterns</area>
171+
<area>Performance</area>
172+
</focus>
173+
<style>
174+
<guideline>Precise terminology</guideline>
175+
<guideline>Code samples</guideline>
176+
<guideline>Document edge cases</guideline>
177+
<guideline>Debugging guidance</guideline>
178+
</style>
179+
</audience>
180+
181+
</audience_sections>
182+
183+
<metadata_patterns>
184+
<version_info>
185+
<template>
186+
### Version Compatibility
187+
| Component | Min | Recommended | Max | Notes |
188+
|-----------|-----|-------------|-----|-------|
189+
| [Component] | [version] | [version] | [version] | [notes] |
190+
</template>
191+
</version_info>
192+
193+
<deprecation_notice>
194+
<template>
195+
> ⚠️ **Deprecated**
196+
>
197+
> Deprecated since: [vX.Y.Z] on [date]
198+
> Removal target: [vA.B.C]
199+
> Migration: See [migration guide](#migration).
200+
> Replacement: [new feature/method].
201+
</template>
202+
</deprecation_notice>
203+
204+
<security_warning>
205+
<template>
206+
> 🔒 **Security Warning**
207+
>
208+
> [Description of concern]
209+
> - **Risk**: [High/Medium/Low]
210+
> - **Affected**: [versions]
211+
> - **Mitigation**: [steps]
212+
> - **References**: [links]
213+
</template>
214+
</security_warning>
215+
216+
<performance_note>
217+
<template>
218+
> ⚡ **Performance Note**
219+
>
220+
> [Description of performance consideration]
221+
> - **Impact**: [metrics]
222+
> - **Optimization**: [approach]
223+
> - **Trade-offs**: [considerations]
224+
</template>
225+
</performance_note>
226+
</metadata_patterns>
227+
228+
<code_documentation_patterns>
229+
<api_endpoint>
230+
<template>
231+
### `[METHOD] /api/[path]`
232+
233+
**Description**: [What this endpoint does]
234+
235+
**Authentication**: [Required/Optional] - [Type]
236+
237+
**Parameters**:
238+
| Name | Type | Required | Description | Example |
239+
|------|------|----------|-------------|---------|
240+
| [param] | [type] | [Yes/No] | [description] | [example] |
241+
242+
**Request Body**:
243+
```json
244+
{
245+
"field": "value"
246+
}
247+
```
248+
249+
**Response**:
250+
- **Success (200)**:
251+
```json
252+
{
253+
"status": "success",
254+
"data": {}
255+
}
256+
```
257+
- **Error (4xx/5xx)**:
258+
```json
259+
{
260+
"error": "error_code",
261+
"message": "Human readable message"
262+
}
263+
```
264+
265+
**Example**:
266+
```bash
267+
curl -X [METHOD] https://api.example.com/[path] \
268+
-H "Authorization: Bearer [token]" \
269+
-H "Content-Type: application/json" \
270+
-d '{"field": "value"}'
271+
```
272+
</template>
273+
</api_endpoint>
274+
275+
<function_documentation>
276+
<template>
277+
### `functionName(parameters)`
278+
279+
**Purpose**: [What this function does]
280+
281+
**Parameters**:
282+
- `param1` (Type): [Description]
283+
- `param2` (Type, optional): [Description] - Default: [value]
284+
285+
**Returns**: `Type` - [Description of return value]
286+
287+
**Throws**:
288+
- `ErrorType`: [When this error occurs]
289+
290+
**Example**:
291+
```typescript
292+
const result = functionName(value1, value2);
293+
// Expected output: [description]
294+
```
295+
296+
**Notes**:
297+
- [Important consideration 1]
298+
- [Important consideration 2]
299+
</template>
300+
</function_documentation>
301+
302+
<configuration_option>
303+
<template>
304+
### `CONFIG_NAME`
305+
306+
**Type**: `string | number | boolean`
307+
308+
**Default**: `default_value`
309+
310+
**Environment Variable**: `APP_CONFIG_NAME`
311+
312+
**Description**: [What this configuration controls]
313+
314+
**Valid Values**:
315+
- `value1`: [Description]
316+
- `value2`: [Description]
317+
318+
**Example**:
319+
```yaml
320+
config:
321+
name: value
322+
```
323+
324+
**Impact**: [What changes when this is modified]
325+
</template>
326+
</configuration_option>
327+
</code_documentation_patterns>
328+
329+
<cross_reference_patterns>
330+
<internal_link>
331+
<format>[Link Text](#section-anchor)</format>
332+
<example>[See Configuration Guide](#configuration)</example>
333+
</internal_link>
334+
335+
<external_link>
336+
<format>[Link Text](https://external.url)</format>
337+
<example>[Official Documentation](https://docs.example.com)</example>
338+
</external_link>
339+
340+
<related_feature>
341+
<template>
342+
> 📌 **Related Features**
343+
> - [Feature A](../feature-a/README.md): [How it relates]
344+
> - [Feature B](../feature-b/README.md): [How it relates]
345+
</template>
346+
</related_feature>
347+
348+
<see_also>
349+
<template>
350+
> 👉 **See Also**
351+
> - [Related Topic 1](#anchor1)
352+
> - [Related Topic 2](#anchor2)
353+
> - [External Resource](https://example.com)
354+
</template>
355+
</see_also>
356+
</cross_reference_patterns>
357+
</documentation_patterns>

0 commit comments

Comments
 (0)