Skip to content

Commit b620a5a

Browse files
committed
Add GitHub Actions workflow for deploying to GitHub Pages
- Create a new workflow file `gh-pages.yml` to automate deployment to GitHub Pages. - Set up steps for checking out the repository, installing `uv`, setting up Python, installing dependencies, building the site with MkDocs, and deploying the built site. - Ensure the workflow triggers on pushes and pull requests to the main branch.
1 parent f1ad48f commit b620a5a

File tree

2 files changed

+45
-15
lines changed

2 files changed

+45
-15
lines changed

.github/workflows/gh-pages.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Install uv
21+
uses: astral-sh/setup-uv@v4
22+
with:
23+
version: "latest"
24+
25+
- name: Setup Python
26+
run: uv python install 3.11
27+
28+
- name: Install dependencies
29+
run: uv sync
30+
31+
- name: Build site
32+
run: uv run mkdocs build
33+
34+
- name: Setup Pages
35+
uses: actions/configure-pages@v4
36+
37+
- name: Upload artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: './site'
41+
42+
- name: Deploy to GitHub Pages
43+
id: deployment
44+
uses: actions/deploy-pages@v4

docs/index.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,8 @@ This book provides a structured approach to evolving Retrieval-Augmented Generat
1919

2020
At the core of this book is the RAG improvement flywheel - a continuous cycle that transforms user interactions into product enhancements.
2121

22-
```mermaid
23-
graph TD
24-
A[Synthetic Data & Evaluation] --> B[Learning from Evaluations]
25-
B --> C[UX Design & Feedback Collection]
26-
C --> D[User Segmentation & Analysis]
27-
D --> E[Building Specialized Capabilities]
28-
E --> F[Unified Product Architecture]
29-
F --> A
30-
31-
style A fill:#f9f,stroke:#333,stroke-width:2px
32-
style C fill:#bbf,stroke:#333,stroke-width:2px
33-
style E fill:#dfd,stroke:#333,stroke-width:2px
34-
```
35-
3622
!!! tip "Beyond Technical Implementation"
37-
This book goes beyond teaching you how to implement RAG. It shows you how to think about RAG as a product that continuously evolves to meet user needs and deliver business value.
23+
This book goes beyond teaching you how to implement RAG. It shows you how to think about RAG as a product that continuously evolves to meet user needs and deliver business value.
3824

3925
## Chapters
4026

0 commit comments

Comments
 (0)