Update project files for improved organization and clarity

- Added new entries to .gitignore to exclude ebook and workshop files.
- Introduced .prettierignore to prevent formatting of specific NDJSON files.
- Made minor formatting adjustments in README and various markdown files for consistency.
- Updated JSON and YAML schemas to streamline data structure requirements.
- Enhanced documentation across multiple files to improve clarity and maintainability.

Author: jxnl

.github/workflows/gh-pages.yml

@@ -2,9 +2,9 @@ name: Deploy to GitHub Pages
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   deploy:
@@ -15,30 +15,30 @@ jobs:
       id-token: write
 
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Install uv
-      uses: astral-sh/setup-uv@v4
-      with:
-        version: "latest"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
 
-    - name: Setup Python
-      run: uv python install 3.11
+      - name: Setup Python
+        run: uv python install 3.11
 
-    - name: Install dependencies
-      run: uv sync
+      - name: Install dependencies
+        run: uv sync
 
-    - name: Build site
-      run: uv run mkdocs build
+      - name: Build site
+        run: uv run mkdocs build
 
-    - name: Setup Pages
-      uses: actions/configure-pages@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
 
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v3
-      with:
-        path: './site'
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "./site"
 
-    - name: Deploy to GitHub Pages
-      id: deployment
-      uses: actions/deploy-pages@v4
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,3 +1,4 @@
+ebook/
 .cache
 .DS_Store
 .venv
@@ -57,4 +58,8 @@ coverage.xml
 .dmypy.json
 chroma_db/
 logs/
-nohup.out
+nohup.out
+
+# Workshop files
+docs/workshops/*.pdf
+docs/workshops/*.txt

.prettierignore

@@ -0,0 +1,5 @@
+# Ignore NDJSON-style files that are not valid single JSON documents
+cohort_2/week5/queries.json
+latest/week5/queries.json
+
+

README.md

@@ -175,27 +175,31 @@ mkdocs build
 ## Getting Started
 
 ### Prerequisites
+
 - Python 3.11 (required - the project uses specific features from this version)
 - `uv` package manager (recommended) or `pip`
 
 ### Installation
 
 1. Clone the repository
 2. Install dependencies:
+
    ```bash
    # Using uv (recommended)
    uv install
-   
+
    # Or using pip
    pip install -e .
    ```
+
 3. Start with `/latest/week0/` for the most up-to-date content
 4. Follow the notebooks in sequential order within each week
 5. Reference the corresponding book chapters in `/docs` for deeper understanding
 
 ### Code Quality
 
 Before committing changes, run:
+
 ```bash
 # Format and fix code issues
 uv run ruff check --fix --unsafe-fixes .
@@ -238,7 +242,7 @@ Want to learn more about RAG? Take our free email course and get the latest news
 **Join thousands of developers who are building better AI applications with our proven methodology.**
 
 --8<--
-  "snippets/enrollment-button.md"
+"snippets/enrollment-button.md"
 --8<--
 
-*Learn evaluation strategies, user experience design, and architectural patterns that actually work in production.*
+_Learn evaluation strategies, user experience design, and architectural patterns that actually work in production._