Skip to content

Commit 33d0167

Browse files
committed
fix invalid asciidoc in asciidoc reference
1 parent 7be15db commit 33d0167

File tree

3 files changed

+48
-10
lines changed

3 files changed

+48
-10
lines changed

asciidoc/courses/workshop-genai/modules/1-generative-ai/lessons/2-building-the-graph/lesson.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,8 @@ image::images/8.png[Diagram showing the Neo4j GraphRAG pipeline process from PDF
170170

171171
[.col]
172172
====
173-
```python
173+
[source, python]
174+
----
174175
pipeline = SimpleKGPipeline(
175176
driver=driver, # Neo4j connection driver
176177
llm=llm, embedder=embedder, # OpenAI llm and embeddings
@@ -186,7 +187,7 @@ pdf_documents = [
186187
# Run the pipeline to transform PDFs into knowledge graph
187188
for pdf_file in pdf_documents:
188189
pipeline.run(file_path=pdf_file)
189-
```
190+
----
190191
====
191192
192193
[.col]

asciidoc/courses/workshop-genai/modules/2-retrievers/lessons/3-hands-on-retrievers/lesson.adoc

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,55 +37,59 @@ Note how each retriever has its place in a complete GraphRAG system!
3737

3838
All retrievers will use the same LLM and embedder for consistency:
3939

40-
```python
40+
[source, python]
41+
----
4142
from neo4j_graphrag.retrievers import VectorRetriever, VectorCypherRetriever, Text2CypherRetriever
4243
4344
llm = OpenAILLM(model_name="gpt-4o", api_key=OPENAI_API_KEY)
4445
embedder = OpenAIEmbeddings(api_key=OPENAI_API_KEY)
45-
```
46+
----
4647

4748
**Vector Retriever:**
4849

4950
- Returns semantically similar text chunks
5051
- Good for exploratory questions
5152
- May miss entity-specific context
5253
53-
```python
54+
[source, python]
55+
----
5456
vector_retriever = VectorRetriever(
5557
driver=driver,
5658
index_name="chunkEmbeddings",
5759
embedder=embedder
5860
)
59-
```
61+
----
6062

6163
**Vector + Cypher Retriever:**
6264

6365
- Provides both content and relationships
6466
- Richer context with entity information
6567
- Better for comprehensive answers
6668
67-
```python
69+
[source, python]
70+
----
6871
vector_cypher_retriever = VectorCypherRetriever(
6972
driver=driver,
7073
index_name="chunkEmbeddings",
7174
retrieval_query=cypher_query,
7275
embedder=embedder
7376
)
74-
```
77+
----
7578

7679
**Text2Cypher Retriever:**
7780

7881
- Direct, precise answers from graph structure
7982
- Perfect for factual queries
8083
- Handles aggregations and counts
8184
82-
```python
85+
[source, python]
86+
----
8387
text2cypher_retriever = Text2CypherRetriever(
8488
driver=driver,
8589
llm=llm,
8690
neo4j_schema=neo4j_schema
8791
)
88-
```
92+
----
8993
====
9094
9195
[.slide]
@@ -120,16 +124,19 @@ read::Continue[]
120124
In this hands-on lesson, you worked with all three retriever types in practice:
121125
122126
**What You Built:**
127+
123128
- Vector Retriever for semantic search
124129
- Vector + Cypher Retriever for contextual search
125130
- Text2Cypher Retriever for precise queries
126131
127132
**Key Insights:**
133+
128134
- Different retrievers excel at different question types
129135
- Combining approaches gives comprehensive coverage
130136
- Understanding retriever strengths guides selection
131137
132138
**Preparation:**
139+
133140
- You now understand how each retriever works in practice
134141
- You've seen their different strengths and limitations
135142
- You're ready to wrap these retrievers as conversational agent tools

docs/asciidoc-elements-reference.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This document provides a comprehensive reference for all AsciiDoc elements and t
77
== Document Header Elements
88

99
=== Basic Document Header
10+
1011
[source,asciidoc]
1112
----
1213
= Lesson Title
@@ -18,13 +19,15 @@ This document provides a comprehensive reference for all AsciiDoc elements and t
1819
**Function:** Defines the lesson title and metadata
1920

2021
**Usage:**
22+
2123
- `:type: lesson` - Identifies this as a lesson file
2224
- `:order: 1` - Sets the lesson order within the module
2325
- `:slides: true` - Enables slide generation for presentations
2426

2527
== Slide Elements
2628

2729
=== Standard Slide
30+
2831
[source,asciidoc]
2932
----
3033
[.slide]
@@ -38,6 +41,7 @@ Content goes here...
3841
**Usage:** The primary container for slide content in lesson presentations
3942

4043
=== Discrete Slide
44+
4145
[source,asciidoc]
4246
----
4347
[.slide.discrete]
@@ -53,6 +57,7 @@ Content without slide numbering...
5357
=== Column Layouts
5458

5559
==== Two-Column Slide
60+
5661
[source,asciidoc]
5762
----
5863
[.slide.col-2]
@@ -74,6 +79,7 @@ Right column content
7479
**Usage:** For side-by-side comparisons, diagrams with explanations, or splitting content
7580

7681
==== Custom Column Ratios
82+
7783
[source,asciidoc]
7884
----
7985
[.slide.col-40-60]
@@ -91,6 +97,7 @@ Content (60% width)
9197
**Usage:** When you need unequal column widths (40-60, 30-70, etc.)
9298

9399
==== Discrete Column Slide
100+
94101
[source,asciidoc]
95102
----
96103
[.slide.discrete.col-2]
@@ -106,6 +113,7 @@ Content in columns without slide numbers
106113
== Content Visibility Elements
107114

108115
=== Transcript-Only Content
116+
109117
[source,asciidoc]
110118
----
111119
[.transcript-only]
@@ -125,6 +133,7 @@ not in slide presentations.
125133
== Navigation Elements
126134

127135
=== Continue Button
136+
128137
[source,asciidoc]
129138
----
130139
read::Continue[]
@@ -147,6 +156,7 @@ read::Mark as Completed[]
147156
== Summary Elements
148157

149158
=== Lesson Summary
159+
150160
[source,asciidoc]
151161
----
152162
[.summary]
@@ -169,6 +179,7 @@ In this lesson, you learned:
169179
== Media Elements
170180

171181
=== Images
182+
172183
[source,asciidoc]
173184
----
174185
image::images/diagram.svg[Alt text description, width=80%]
@@ -177,16 +188,19 @@ image::images/diagram.svg[Alt text description, width=80%]
177188
**Function:** Embeds images with optional sizing and alt text
178189

179190
**Usage:**
191+
180192
- Diagrams and illustrations
181193
- Screenshots and examples
182194
- Visual explanations
183195

184196
**Options:**
197+
185198
- `width=80%` - Sets image width as percentage
186199
- `width=500` - Sets absolute pixel width
187200
- Alt text in brackets for accessibility
188201

189202
=== Videos
203+
190204
[source,asciidoc]
191205
----
192206
video::AhMjmxLPEWM[youtube,width=560,height=315]
@@ -197,6 +211,7 @@ video::AhMjmxLPEWM[youtube,width=560,height=315]
197211
**Usage:** For demonstration videos, tutorials, or additional explanations
198212

199213
=== Includes
214+
200215
[source,asciidoc]
201216
----
202217
include::apple-embedding.adoc[lines=1]
@@ -205,17 +220,20 @@ include::apple-embedding.adoc[lines=1]
205220
**Function:** Includes content from external files
206221

207222
**Usage:**
223+
208224
- Reusable content blocks
209225
- Shared examples or data
210226
- Modular lesson components
211227

212228
**Options:**
229+
213230
- `lines=1` - Include only specific lines
214231
- `tags=section1` - Include tagged sections
215232

216233
== Layout Helpers
217234

218235
=== Column Containers
236+
219237
[source,asciidoc]
220238
----
221239
[.col]
@@ -229,6 +247,7 @@ Column content here
229247
**Usage:** Must be used inside `.col-2` or similar column slide layouts
230248

231249
=== Discrete Styling
250+
232251
[source,asciidoc]
233252
----
234253
[.discrete]
@@ -244,12 +263,15 @@ Column content here
244263
=== Content Organization Guidelines
245264

246265
==== Avoid Numbered References
266+
247267
**❌ Don't use:**
268+
248269
- "In Lesson 2, we learned..."
249270
- "From Module 1, you'll remember..."
250271
- "As we saw in Lesson 3..."
251272

252273
**✅ Use instead:**
274+
253275
- "In the previous lesson, we learned..."
254276
- "Earlier, you learned..."
255277
- "As we saw when building the knowledge graph..."
@@ -258,25 +280,29 @@ Column content here
258280
**Why:** Numbered references create maintenance problems when content gets reorganized, lessons are reordered, or modules are restructured.
259281

260282
=== Slide Design
283+
261284
1. **Keep slides concise** - Use bullet points and short phrases
262285
2. **Use transcript-only for details** - Put lengthy explanations in transcript blocks
263286
3. **Balance columns** - Ensure column content is roughly equal in length
264287
4. **Include alt text** - Always provide descriptive alt text for images
265288

266289
=== Content Organization
290+
267291
1. **Start with discrete slide** - Use `[.slide.discrete]` for introduction
268292
2. **End with summary** - Always include a `[.summary]` section
269293
3. **Add continue button** - Include `read::Continue[]` for navigation
270294
4. **Use consistent titles** - Follow the same heading structure throughout
271295

272296
=== Accessibility
297+
273298
1. **Alt text for images** - Describe what the image shows
274299
2. **Logical heading hierarchy** - Use proper heading levels (==, ===, etc.)
275300
3. **Meaningful link text** - Avoid "click here" type links
276301

277302
== Common Patterns
278303

279304
=== Standard Lesson Structure
305+
280306
[source,asciidoc]
281307
----
282308
= Lesson Title
@@ -323,6 +349,7 @@ read::Continue[]
323349
[.col]
324350
====
325351
**Before:**
352+
326353
- Traditional approach
327354
- Limitations
328355
- Problems
@@ -331,19 +358,22 @@ read::Continue[]
331358
[.col]
332359
====
333360
**After:**
361+
334362
- New approach
335363
- Benefits
336364
- Solutions
337365
====
338366
----
339367

340368
=== Hands-On Section
369+
341370
[source,asciidoc]
342371
----
343372
[.slide]
344373
== Try It Yourself
345374
346375
**Your task:**
376+
347377
1. Step one instruction
348378
2. Step two instruction
349379
3. Step three instruction

0 commit comments

Comments
 (0)