Skip to content

Commit b9b0f82

Browse files
Reorganize course documentation and add platform guides
- Restructure Data Engineering Zoomcamp: move pages to Logistics folder (homework, deadlines, leaderboard, projects, communication, certification, learning-in-public) - Create Course Management Platform documentation with screenshots (dashboard, homework, projects, peer review, leaderboard, contributing) - Add FAQ documentation page with contribution guidelines - Add Learning in Public guide with course-specific instructions - Update all internal links to use relative_url filter - Add navigation links between related pages - Update dataset page with Parquet format info and data sources - Update resources with clickable GitHub links - Add course time commitment dashboard links - Add Telegram channel to getting started - Link Slack guide from community pages - Add certificate image and project submission screenshots - Fix image syntax to use HTML img tags with relative_url
1 parent 31aea02 commit b9b0f82

Some content is hidden

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

43 files changed

+819
-250
lines changed

AGENTS.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,43 @@
22

33
- Don't use long dashes. Always put spaces around dashes.
44
- Don't use bold or italic formatting in markdown files. Use plain text.
5-
- Don't use tables. Use lists instead.
5+
- Don't use tables. Use lists instead.
6+
7+
## Links and Images
8+
9+
Internal links and images should use Jekyll's `relative_url` filter to ensure they work correctly regardless of the site's base URL configuration.
10+
11+
### Internal Links
12+
13+
Use the `relative_url` filter for internal links:
14+
15+
```markdown
16+
[Link text]({{ '/path/to/page/' | relative_url }})
17+
```
18+
19+
Example:
20+
```markdown
21+
[platform documentation]({{ '/courses/course-management-platform/' | relative_url }})
22+
```
23+
24+
Do NOT include `/notes/` prefix in the path - `relative_url` handles this automatically.
25+
26+
Incorrect:
27+
```markdown
28+
[Link text](/notes/courses/course-management-platform/)
29+
```
30+
31+
### Images
32+
33+
Use HTML img tags with `relative_url` filter:
34+
35+
```markdown
36+
<img src="{{ '/assets/images/path/to/image.jpg' | relative_url }}" alt="Description" width="80%">
37+
```
38+
39+
Do NOT use markdown image syntax:
40+
```markdown
41+
![Description](/notes/assets/images/path/to/image.jpg)
42+
```
43+
44+
Do NOT include `/notes/` prefix in the path - `relative_url` handles this automatically.

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ When adding images to your markdown files, please follow these guidelines:
1111

1212
**Correct Image Reference:**
1313
```markdown
14-
![Image Description](/notes/assets/images/your-path/image.png)
14+
<img src="{{ '/assets/images/your-path/image.png' | relative_url }}" alt="Image Description" width="80%">
1515
```
1616

1717
**Incorrect Image Reference:**
1818
```markdown
19-
![Image Description](/assets/images/your-path/image.png)
19+
![Image Description](/notes/assets/images/your-path/image.png)
2020
```
2121

2222
This is necessary because the site is configured with a baseurl of `/notes` in the `_config.yml` file. Without this prefix, images will not display correctly when the site is deployed.

_private/llm-zoomcamp/module-01-introduction/notes-1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ When you interact with ChatGPT, Claude, or similar models, you experience:
116116
117117
### How LLMs Process Your Requests
118118

119-
![LLM Processing](/notes/assets/images/llm-zoomcamp/module-1/lecture-1-llms.png)
119+
<img src="{{ '/assets/images/llm-zoomcamp/module-1/lecture-1-llms.png' | relative_url }}" alt="LLM Processing" width="80%">
120120
*Figure 1: LLM Processing*
121121

122122
Understanding the basic input-output flow helps us use LLMs more effectively:
@@ -151,7 +151,7 @@ This works perfectly because cooking salmon is well-documented in the LLM's trai
151151

152152
**Scenario 2 - LLM Knowledge Gap**:
153153

154-
![Why we need RAG](/notes/assets/images/llm-zoomcamp/module-1/lecture-1-why-we-need-rag.png)
154+
<img src="{{ '/assets/images/llm-zoomcamp/module-1/lecture-1-why-we-need-rag.png' | relative_url }}" alt="Why we need RAG" width="80%">
155155

156156
```
157157
Question: "Is it too late to join the Data Engineering Zoomcamp?"
@@ -181,7 +181,7 @@ If we just connected students directly to ChatGPT, they'd get generic answers th
181181

182182
### What is RAG?
183183

184-
![RAG Overview](/notes/assets/images/llm-zoomcamp/module-1/lecture-1-rag.png)
184+
<img src="{{ '/assets/images/llm-zoomcamp/module-1/lecture-1-rag.png' | relative_url }}" alt="RAG Overview" width="80%">
185185

186186
**RAG = Retrieval (Search) + Augmented (Enhanced) + Generation (LLM)**
187187

_sass/custom/custom.scss

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,15 @@ p, li, h1, h2, h3, h4, h5, h6 {
8787
.main-content {
8888
flex: 1;
8989
max-width: 100%;
90-
90+
9191
@media (min-width: 50rem) {
9292
max-width: 75%;
9393
padding-right: 2rem;
9494
}
95+
96+
h3 {
97+
margin-bottom: 1rem;
98+
}
9599
}
96100

97101
.page-toc {
44.1 KB
Loading
33.3 KB
Loading
35.3 KB
Loading
21.1 KB
Loading
50.3 KB
Loading
39.2 KB
Loading

0 commit comments

Comments
 (0)