zenml-io
diff --git a/‎.github/workflows/check-links.yml‎
Lines changed: 161 additions & 0 deletions b/‎.github/workflows/check-links.yml‎
Lines changed: 161 additions & 0 deletions
diff --git a/‎README.md‎
Lines changed: 3 additions & 3 deletions b/‎README.md‎
Lines changed: 3 additions & 3 deletions
diff --git a/‎docs/README.md‎
Lines changed: 56 additions & 0 deletions b/‎docs/README.md‎
Lines changed: 56 additions & 0 deletions
diff --git a/‎docs/book/.gitbook/assets/alerter.png‎
74.6 KB b/‎docs/book/.gitbook/assets/alerter.png‎
74.6 KB
diff --git a/‎docs/book/.gitbook/assets/annotator.png‎
74.4 KB b/‎docs/book/.gitbook/assets/annotator.png‎
74.4 KB
diff --git a/‎docs/book/.gitbook/assets/artifact-store.png‎
74.3 KB b/‎docs/book/.gitbook/assets/artifact-store.png‎
74.3 KB
diff --git a/‎docs/book/.gitbook/assets/component-guide.png‎
131 KB b/‎docs/book/.gitbook/assets/component-guide.png‎
131 KB
diff --git a/‎docs/book/.gitbook/assets/container-registry.png‎
74.5 KB b/‎docs/book/.gitbook/assets/container-registry.png‎
74.5 KB
diff --git a/‎docs/book/.gitbook/assets/core-concepts.png‎
142 KB b/‎docs/book/.gitbook/assets/core-concepts.png‎
142 KB
diff --git a/‎docs/book/.gitbook/assets/data-scientist.png‎
153 KB b/‎docs/book/.gitbook/assets/data-scientist.png‎
153 KB
@@ -0,0 +1,161 @@
+---
+name: Check Links
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+    paths-ignore: [src/**, tests/**, '**.py']
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths-ignore: [src/**, tests/**, '**.py']
+concurrency:
+  # New commit on branch cancels running workflows of the same branch
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  check-absolute-links:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    outputs:
+      exit_code: ${{ steps.check-absolute.outputs.exit_code }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: pip install requests
+      - name: Check Absolute Links
+        id: check-absolute
+        run: |
+          # Only check absolute links (http/https), not relative links
+          python docs/link_checker.py --dir docs/book --substring "http" --validate-links --timeout 15 --ci-mode
+          # Capture the exit code even if the command fails
+          EXIT_CODE=$?
+          echo "exit_code=$EXIT_CODE" >> $GITHUB_OUTPUT
+          # Don't exit with error yet, as we want to keep the exit code for the summary step
+          exit 0
+      - name: Mark job status based on check result
+        if: steps.check-absolute.outputs.exit_code != '0'
+        run: |
+          echo "::error::Absolute links check failed! Found broken links."
+          exit 1
+  check-relative-links:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    outputs:
+      exit_code: ${{ steps.check-relative.outputs.exit_code }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Check Relative Links
+        id: check-relative
+        run: |
+          # Check if relative links resolve within the repository
+          python scripts/check_relative_links.py --dir docs/book
+          # Capture the exit code even if the command fails
+          EXIT_CODE=$?
+          echo "exit_code=$EXIT_CODE" >> $GITHUB_OUTPUT
+          # Don't exit with error yet, as we want to keep the exit code for the summary step
+          exit 0
+      - name: Mark job status based on check result
+        if: steps.check-relative.outputs.exit_code != '0'
+        run: |
+          echo "::error::Relative links check failed! Found broken links."
+          exit 1
+  post-summary:
+    needs: [check-absolute-links, check-relative-links]
+    if: always() && github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create Summary
+        id: create-summary
+        run: |
+          echo "# Documentation Link Check Results" >> $GITHUB_STEP_SUMMARY
+
+          # Initialize FAILED variable
+          FAILED=false
+
+          # Create summary content for PR comment
+          cat << 'EOL' > comment_beginning.txt
+          ## Documentation Link Check Results
+          EOL
+
+          # Check for failures in absolute links job
+          if [[ "${{ needs.check-absolute-links.outputs.exit_code }}" != "0" ]]; then
+            echo "❌ **Absolute links check failed**" >> $GITHUB_STEP_SUMMARY
+            echo "There are broken absolute links in the documentation. Please check the job logs for details." >> $GITHUB_STEP_SUMMARY
+            cat << 'EOL' > comment_absolute.txt
+          ❌ **Absolute links check failed**
+          There are broken absolute links in the documentation. [See workflow logs for details](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})
+          EOL
+            FAILED=true
+          else
+            echo "✅ **Absolute links check passed**" >> $GITHUB_STEP_SUMMARY
+            cat << 'EOL' > comment_absolute.txt
+          ✅ **Absolute links check passed**
+          EOL
+          fi
+
+          # Check for failures in relative links job
+          if [[ "${{ needs.check-relative-links.outputs.exit_code }}" != "0" ]]; then
+            echo "❌ **Relative links check failed**" >> $GITHUB_STEP_SUMMARY
+            echo "There are broken relative links in the documentation. Please check the job logs for details." >> $GITHUB_STEP_SUMMARY
+            cat << 'EOL' > comment_relative.txt
+          ❌ **Relative links check failed**
+          There are broken relative links in the documentation. [See workflow logs for details](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})
+          EOL
+            FAILED=true
+          else
+            echo "✅ **Relative links check passed**" >> $GITHUB_STEP_SUMMARY
+            cat << 'EOL' > comment_relative.txt
+          ✅ **Relative links check passed**
+          EOL
+          fi
+
+          # Add timestamp
+          cat << EOL > comment_footer.txt
+          <sub>Last checked: $(date -u '+%Y-%m-%d %H:%M:%S UTC')</sub>
+          EOL
+
+          # Combine all parts
+          cat comment_beginning.txt comment_absolute.txt comment_relative.txt comment_footer.txt > full_comment.txt
+
+          # Save comment body to output
+          echo "comment_body<<EOF" >> $GITHUB_OUTPUT
+          cat full_comment.txt >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+          # Save failed status to output
+          echo "failed=$FAILED" >> $GITHUB_OUTPUT
+
+          # Do not exit with error - we want to post the comment first
+      - name: Find Comment
+        uses: peter-evans/find-comment@v3
+        if: github.event_name == 'pull_request'
+        id: find-comment
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: github-actions[bot]
+          body-includes: Documentation Link Check Results
+      - name: Create or Update Comment
+        uses: peter-evans/create-or-update-comment@v4
+        if: github.event_name == 'pull_request'
+        with:
+          comment-id: ${{ steps.find-comment.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: ${{ steps.create-summary.outputs.comment_body }}
+          edit-mode: replace
+
+      # This step runs after comment is posted and fails the workflow if links are broken
+      - name: Report Link Check Status
+        if: steps.create-summary.outputs.failed == 'true'
+        run: |-
+          echo "::error::One or more link checks failed. Please fix the broken links."
+          exit 1
@@ -266,7 +266,7 @@ And finally, here are some other examples and use cases for inspiration:
 
 1. [E2E Batch Inference](examples/e2e/): Feature engineering, training, and inference pipelines for tabular machine learning.
 2. [Basic NLP with BERT](examples/e2e_nlp/): Feature engineering, training, and inference focused on NLP.
-3. [LLM RAG Pipeline with Langchain and OpenAI](https://github.com/zenml-io/zenml-projects/tree/main/llm-agents): Using Langchain to create a simple RAG pipeline.
+3. [LLM RAG Pipeline with Langchain and OpenAI](https://github.com/zenml-io/zenml-projects/tree/main/zenml-support-agent): Using Langchain to create a simple RAG pipeline.
 4. [Huggingface Model to Sagemaker Endpoint](https://github.com/zenml-io/zenml-projects/tree/main/huggingface-sagemaker): Automated MLOps on Amazon Sagemaker and HuggingFace
 5. [LLMops](https://github.com/zenml-io/zenml-projects/tree/main/llm-complete-guide): Complete guide to do LLM with ZenML
 
@@ -341,8 +341,8 @@ our GitHub repo.
 ## 📚 LLM-focused Learning Resources
 
 1. [LL Complete Guide - Full RAG Pipeline](https://github.com/zenml-io/zenml-projects/tree/main/llm-complete-guide) - Document ingestion, embedding management, and query serving
-2. [LLM Fine-Tuning Pipeline](https://github.com/zenml-io/zenml-projects/tree/main/llm-finetuning) - From data prep to deployed model
-3. [LLM Agents Example](https://github.com/zenml-io/zenml-projects/tree/main/llm-agents) - Track conversation quality and tool usage
+2. [LLM Fine-Tuning Pipeline](https://github.com/zenml-io/zenml-projects/tree/main/zencoder) - From data prep to deployed model
+3. [LLM Agents Example](https://github.com/zenml-io/zenml-projects/tree/main/zenml-support-agent) - Track conversation quality and tool usage
 
 ## 🤖 AI-Friendly Documentation with llms.txt
 
 
@@ -47,6 +47,62 @@ rm -rf src/zenml/zen_stores/migrations/script.py.mako
 running it from elsewhere can lead to unexpected errors. This script will compose the docs hierarchy
 and serve it (http://127.0.0.1:<PORT>/).
 
+## Link Checker Tool
+
+The `link_checker.py` script is a utility tool for managing and validating links in our documentation.
+It helps maintain the quality of our documentation by:
+
+* Finding broken or outdated links
+* Converting relative links to absolute URLs
+* Validating link accessibility
+* Supporting both directory-wide and file-specific scanning
+
+### Usage
+
+The script supports several modes of operation:
+
+```bash
+# Find all links containing 'docs.zenml.io' in a directory
+python link_checker.py --dir docs/book --substring docs.zenml.io
+
+# Check specific files for links containing 'how-to'
+python link_checker.py --files file1.md file2.md --substring how-to
+
+# Preview link replacements without making changes
+python link_checker.py --files file1.md --replace-links --dry-run
+
+# Replace and validate links
+python link_checker.py --files file1.md --replace-links --validate-links
+
+# Transform paths using custom URL mappings
+python link_checker.py --dir docs/book --replace-links --url-mapping user-guide=user-guides
+```
+
+### Features
+
+1. **Link Detection**:
+   - Scans for various link types (inline, reference-style, HTML, bare URLs)
+   - Supports substring-based filtering
+   - Works with both directories and individual files
+
+2. **Link Transformation**:
+   - Converts relative documentation links to absolute URLs
+   - Handles README.md files and various link formats
+   - Preserves fragments and query parameters
+   - Supports custom URL path mappings to transform specific path segments
+
+3. **Link Validation**:
+   - Validates links via HTTP requests
+   - Parallel validation for better performance
+   - Detailed error reporting
+
+### Requirements
+
+For link validation functionality, the `requests` package is required:
+```bash
+pip install requests
+```
+
 ## Contributors
 
 We welcome and recognize all contributions. You can see a list of current contributors [here](https://github.com/zenml-io/zenml/graphs/contributors).