mgbam commited on
Commit
fb36540
·
verified ·
1 Parent(s): 54bd1b8

Update docs/USER_GUIDE.md

Browse files
Files changed (1) hide show
  1. docs/USER_GUIDE.md +51 -0
docs/USER_GUIDE.md CHANGED
@@ -0,0 +1,51 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!-- docs/USER_GUIDE.md -->
2
+
3
+ # User Guide
4
+
5
+ ## Sidebar
6
+
7
+ - **Model**: Select among HF, OpenAI, Gemini, Groq, and Fireworks models.
8
+ - **Input**: Describe your app or paste code/text.
9
+ - **Generate**: Click to invoke the AI pipeline.
10
+
11
+ ## Tabs
12
+
13
+ - **Code**: View generated code (editable).
14
+ - **Preview**: Live HTML preview (for web outputs).
15
+ - **History**: Conversation log with assistant.
16
+
17
+ ## Files & Plugins
18
+
19
+ - Upload reference files (PDF, DOCX, images) for extraction.
20
+ - Use **Plugins** to integrate GitHub, Slack, DB queries, etc.
21
+
22
+ ---
23
+
24
+ ```markdown
25
+ <!-- docs/API_REFERENCE.md -->
26
+
27
+ # API Reference
28
+
29
+ ## `models.py`
30
+
31
+ ### `ModelInfo`
32
+ - `name: str`
33
+ - `id: str`
34
+ - `description: str`
35
+ - `default_provider: str`
36
+
37
+ ### `find_model(identifier: str) -> Optional[ModelInfo]`
38
+
39
+ ## `inference.py`
40
+
41
+ ### `chat_completion(model_id, messages, provider=None, max_tokens=4096) -> str`
42
+
43
+ ### `stream_chat_completion(model_id, messages, provider=None, max_tokens=4096) -> Generator[str]`
44
+
45
+ ---
46
+
47
+ ```markdown
48
+ <!-- docs/ARCHITECTURE.md -->
49
+
50
+ # Architecture
51
+