-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathai-documentation-generator.js
More file actions
308 lines (275 loc) · 9.26 KB
/
ai-documentation-generator.js
File metadata and controls
308 lines (275 loc) · 9.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
/**
* Rahyana AI API - تولیدکننده مستندات هوش مصنوعی
*
* این پروژه یک سیستم کامل برای تولید مستندات با AI شامل:
* - تولید README خودکار
* - مستندسازی API
* - تولید مثالهای کد
* - مستندات فنی
* - راهنمای کاربر
* - مستندات چندزبانه
*/
// Configuration - supports environment variable or placeholder
const API_KEY = process.env.RAHYANA_API_KEY || 'YOUR_API_KEY_HERE'; // کلید API خود را اینجا قرار دهید یا از متغیر محیطی RAHYANA_API_KEY استفاده کنید
const BASE_URL = process.env.RAHYANA_BASE_URL || 'https://rahyana.ir/api/v1';
class AIDocumentationGenerator {
constructor(apiKey, baseUrl) {
this.apiKey = apiKey;
this.baseUrl = baseUrl;
this.templates = new Map();
this.languages = ['fa', 'en', 'ar', 'tr'];
}
// تولید README
async generateReadme(projectInfo) {
try {
const prompt = `
README کامل برای پروژه زیر تولید کنید:
نام پروژه: ${projectInfo.name}
توضیحات: ${projectInfo.description}
ویژگیها: ${projectInfo.features.join(', ')}
تکنولوژیها: ${projectInfo.technologies.join(', ')}
نصب: ${projectInfo.installation || 'npm install'}
استفاده: ${projectInfo.usage || 'node index.js'}
README باید شامل:
1. عنوان و توضیحات جذاب
2. ویژگیهای کلیدی
3. نصب و راهاندازی
4. مثالهای استفاده
5. API documentation
6. مشارکت
7. مجوز
8. لینکهای مفید
`;
const response = await fetch(`${this.baseUrl}/chat/completions`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${this.apiKey}`,
'Content-Type': 'application/json',
'HTTP-Referer': 'https://ai-docs-app.com',
'X-Title': 'AI Documentation Generator'
},
body: JSON.stringify({
model: 'openai/gpt-4o',
messages: [
{
role: 'system',
content: 'شما یک متخصص تولید مستندات فنی و README هستید.'
},
{
role: 'user',
content: prompt
}
],
temperature: 0.4,
max_tokens: 2500
})
});
if (!response.ok) {
throw new Error(`خطای HTTP! وضعیت: ${response.status}`);
}
const data = await response.json();
return data.choices[0].message.content;
} catch (error) {
console.error('خطا در تولید README:', error);
throw error;
}
}
// مستندسازی API
async generateApiDocs(apiEndpoints) {
try {
const prompt = `
مستندات API کامل برای endpoint های زیر تولید کنید:
${JSON.stringify(apiEndpoints, null, 2)}
مستندات شامل:
1. توضیح کلی API
2. Authentication
3. هر endpoint با جزئیات:
- Method و URL
- Parameters
- Request body
- Response format
- Error codes
- مثالهای کد
4. Rate limiting
5. Best practices
`;
const response = await fetch(`${this.baseUrl}/chat/completions`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${this.apiKey}`,
'Content-Type': 'application/json',
'HTTP-Referer': 'https://ai-docs-app.com',
'X-Title': 'AI Documentation Generator'
},
body: JSON.stringify({
model: 'openai/gpt-4o',
messages: [
{
role: 'system',
content: 'شما یک متخصص مستندسازی API و OpenAPI هستید.'
},
{
role: 'user',
content: prompt
}
],
temperature: 0.3,
max_tokens: 3000
})
});
if (!response.ok) {
throw new Error(`خطای HTTP! وضعیت: ${response.status}`);
}
const data = await response.json();
return data.choices[0].message.content;
} catch (error) {
console.error('خطا در تولید مستندات API:', error);
throw error;
}
}
// تولید مثالهای کد
async generateCodeExamples(functions, language = 'javascript') {
try {
const prompt = `
مثالهای کد ${language} برای توابع زیر تولید کنید:
${JSON.stringify(functions, null, 2)}
مثالها شامل:
1. مثالهای ساده
2. مثالهای پیشرفته
3. Error handling
4. Best practices
5. کامنتهای مفصل
6. تستها
`;
const response = await fetch(`${this.baseUrl}/chat/completions`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${this.apiKey}`,
'Content-Type': 'application/json',
'HTTP-Referer': 'https://ai-docs-app.com',
'X-Title': 'AI Documentation Generator'
},
body: JSON.stringify({
model: 'openai/gpt-4o',
messages: [
{
role: 'system',
content: 'شما یک متخصص تولید مثالهای کد و آموزش برنامهنویسی هستید.'
},
{
role: 'user',
content: prompt
}
],
temperature: 0.5,
max_tokens: 2000
})
});
if (!response.ok) {
throw new Error(`خطای HTTP! وضعیت: ${response.status}`);
}
const data = await response.json();
return data.choices[0].message.content;
} catch (error) {
console.error('خطا در تولید مثالهای کد:', error);
throw error;
}
}
// تولید مستندات چندزبانه
async generateMultilingualDocs(content, targetLanguage) {
try {
const prompt = `
محتوای زیر را به زبان ${targetLanguage} ترجمه کنید:
${content}
الزامات:
1. ترجمه دقیق و طبیعی
2. حفظ اصطلاحات فنی
3. فرمت markdown
4. لینکها و کدها دست نخورده
5. مناسب برای مخاطب ${targetLanguage}
`;
const response = await fetch(`${this.baseUrl}/chat/completions`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${this.apiKey}`,
'Content-Type': 'application/json',
'HTTP-Referer': 'https://ai-docs-app.com',
'X-Title': 'AI Documentation Generator'
},
body: JSON.stringify({
model: 'openai/gpt-4o',
messages: [
{
role: 'system',
content: `شما یک مترجم متخصص و تولیدکننده مستندات فنی به زبان ${targetLanguage} هستید.`
},
{
role: 'user',
content: prompt
}
],
temperature: 0.3,
max_tokens: 2000
})
});
if (!response.ok) {
throw new Error(`خطای HTTP! وضعیت: ${response.status}`);
}
const data = await response.json();
return data.choices[0].message.content;
} catch (error) {
console.error('خطا در تولید مستندات چندزبانه:', error);
throw error;
}
}
// تولید راهنمای کاربر
async generateUserGuide(features, userType = 'beginner') {
try {
const prompt = `
راهنمای کاربر ${userType} برای ویژگیهای زیر تولید کنید:
${JSON.stringify(features, null, 2)}
راهنما شامل:
1. مقدمه و شروع
2. نصب و راهاندازی
3. آموزش گام به گام
4. مثالهای عملی
5. حل مشکلات رایج
6. نکات و ترفندها
7. منابع بیشتر
`;
const response = await fetch(`${this.baseUrl}/chat/completions`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${this.apiKey}`,
'Content-Type': 'application/json',
'HTTP-Referer': 'https://ai-docs-app.com',
'X-Title': 'AI Documentation Generator'
},
body: JSON.stringify({
model: 'openai/gpt-4o',
messages: [
{
role: 'system',
content: `شما یک متخصص تولید راهنمای کاربر برای ${userType} هستید.`
},
{
role: 'user',
content: prompt
}
],
temperature: 0.4,
max_tokens: 2500
})
});
if (!response.ok) {
throw new Error(`خطای HTTP! وضعیت: ${response.status}`);
}
const data = await response.json();
return data.choices[0].message.content;
} catch (error) {
console.error('خطا در تولید راهنمای کاربر:', error);
throw error;
}
}
}
export default AIDocumentationGenerator;