Skip to content

Commit d57ce0a

Browse files
committed
feat: enhance documentation and UI with improved copy functionality and styling adjustments
1 parent 61626cd commit d57ce0a

6 files changed

Lines changed: 62 additions & 15 deletions

File tree

docs/_layouts/default.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,30 @@
6868
btn.textContent = 'Copy';
6969
btn.classList.remove('copied');
7070
}, 2000);
71+
}).catch(() => {
72+
const ta = document.createElement('textarea');
73+
ta.value = text;
74+
ta.style.position = 'fixed';
75+
ta.style.opacity = '0';
76+
document.body.appendChild(ta);
77+
ta.select();
78+
try {
79+
document.execCommand('copy');
80+
btn.textContent = 'Copied!';
81+
btn.classList.add('copied');
82+
setTimeout(() => {
83+
btn.textContent = 'Copy';
84+
btn.classList.remove('copied');
85+
}, 2000);
86+
} catch (e) {
87+
btn.textContent = 'Copy failed';
88+
btn.classList.add('copy-error');
89+
setTimeout(() => {
90+
btn.textContent = 'Copy';
91+
btn.classList.remove('copy-error');
92+
}, 2000);
93+
}
94+
document.body.removeChild(ta);
7195
});
7296
});
7397

docs/assets/css/style.css

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,21 +110,36 @@ body {
110110
.main-content {
111111
flex: 1;
112112
margin-left: 260px;
113-
padding: 40px 48px;
114-
max-width: 1000px;
113+
padding: 48px 48px 40px;
114+
min-width: 0;
115+
max-width: 1440px;
115116
}
116117

117118
.content-wrapper {
118-
max-width: 800px;
119+
max-width: 1200px;
119120
}
120121

121122
.content-wrapper h1 {
122-
font-size: 2.5rem;
123+
font-size: 2.8rem;
123124
color: #f0f6fc;
124125
margin-top: 0;
125-
margin-bottom: 24px;
126+
margin-bottom: 16px;
126127
border-bottom: 1px solid #21262d;
127-
padding-bottom: 12px;
128+
padding-bottom: 16px;
129+
}
130+
131+
.content-wrapper h1 + p {
132+
font-size: 1.15rem;
133+
color: #8b949e;
134+
margin-top: 0;
135+
margin-bottom: 8px;
136+
}
137+
138+
.content-wrapper h1 + p + hr {
139+
margin-top: 20px;
140+
margin-bottom: 32px;
141+
border: none;
142+
border-top: 1px solid #21262d;
128143
}
129144

130145
.content-wrapper h2 {
@@ -164,12 +179,12 @@ body {
164179
}
165180

166181
.content-wrapper pre {
167-
background: #010409;
182+
background: #161b22;
168183
border: 1px solid #30363d;
169184
border-radius: 8px;
170-
padding: 16px;
185+
padding: 20px;
171186
overflow-x: auto;
172-
font-size: 0.9rem;
187+
font-size: 0.85rem;
173188
line-height: 1.5;
174189
margin: 0;
175190
}
@@ -191,7 +206,9 @@ body {
191206
transition: opacity 0.2s, background 0.2s, color 0.2s, border-color 0.2s;
192207
}
193208

194-
.code-wrapper:hover .copy-btn {
209+
.code-wrapper:hover .copy-btn,
210+
.code-wrapper:focus-within .copy-btn,
211+
.copy-btn:focus {
195212
opacity: 1;
196213
}
197214

@@ -208,7 +225,7 @@ body {
208225
}
209226

210227
.content-wrapper code {
211-
font-family: ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas, Liberation Mono, monospace;
228+
font-family: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, "Liberation Mono", monospace;
212229
background: #161b22;
213230
padding: 0.2em 0.4em;
214231
border-radius: 6px;

docs/collections.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ title: "Collections & Quantization"
55

66
# Managing Collections
77

8+
Create, list, inspect, configure, and delete Qdrant collections with optional quantization for memory optimization.
9+
810
---
911

1012
## SHOW COLLECTIONS — list collections

docs/reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ title: "Reference"
55

66
# Reference — Models, Config, Project Structure, Errors
77

8+
Default embedding models, configuration parameters, project layout, and common error codes for troubleshooting.
9+
810
---
911

1012
## Embedding Models

docs/search.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ title: "SEARCH / SELECT / RECOMMEND"
55

66
# SEARCH, SELECT, SCROLL, RECOMMEND, Hybrid Search & Reranking
77

8+
QQL supports semantic (dense), sparse (BM25/SPLADE), and hybrid search with optional reranking, SELECT for point retrieval, SCROLL for pagination, and RECOMMEND for example-driven discovery.
9+
810
---
911

1012
## SEARCH — find similar points

examples_and_applications/healthcare_conversation_rag/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This application loads a dataset of doctor-patient conversations into Qdrant and
2323
# Install dependencies
2424
pip install -e ../.. # install qql from the repo root
2525

26-
# Or install from pyproject.toml
26+
# Or install from PyPI
2727
pip install qql-cli datasets agno ollama openai
2828
```
2929

@@ -74,15 +74,15 @@ python main.py
7474

7575
The agent will launch and you can ask medical questions in natural language. For example:
7676

77-
```
77+
```text
7878
hi doctor I am just wondering what does abutment of the nerve root mean in a back issue please explain what treatment is required for annular bulging and tear
7979
```
8080

8181
The agent will call `search_medical_records` to retrieve relevant conversation context from Qdrant, then generate a response.
8282

8383
## Project Structure
8484

85-
```
85+
```text
8686
healthcare_conversation_rag/
8787
├── main.py # AI agent with search tool
8888
├── create_dataset.py # Generates .qql file from HuggingFace dataset
@@ -119,7 +119,7 @@ healthcare_conversation_rag/
119119
**Adjust search params** — modify the `WITH { ... }` block in `main.py:search_medical_records()`:
120120

121121
```python
122-
query = f"SEARCH medical_records SIMILAR TO '{question}' LIMIT {LIMIT} WITH {{ hnsw_ef: 128, mmr_diversity: 0.5, mmr_candidates: 50}}"
122+
query = f"SEARCH doctor_patient_conversation SIMILAR TO '{question}' LIMIT {LIMIT} WITH {{ hnsw_ef: 128, mmr_diversity: 0.5, mmr_candidates: 50}}"
123123
```
124124

125125
**Use a different model** — change the `Ollama(id=...)` in `main.py`.

0 commit comments

Comments
 (0)