Merge branch 'main' into translate/hi-starting-a-project

Author: ItsMeAnanyaSrivastava

.github/workflows/jekyll-preview.yml

@@ -30,7 +30,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.0
+        uses: actions/checkout@v6.0.1
         with:
           # For PRs make sure to checkout the PR branch
           ref: ${{ github.event.pull_request.head.sha }}

.github/workflows/jekyll.yml

@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.0
+        uses: actions/checkout@v6.0.1
       - name: Setup Pages
         uses: actions/configure-pages@v5.0.0
       - name: Build with Jekyll

.github/workflows/stale.yml

@@ -11,7 +11,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v10.1.0
+      - uses: actions/stale@v10.1.1
         with:
           stale-pr-message: >
             This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

.github/workflows/tests.yml

@@ -11,13 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Git repository
-        uses: actions/checkout@v6.0.0
+        uses: actions/checkout@v6.0.1
       - name: Set up Ruby
         uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1
         with:
           bundler-cache: true
       - name: Set up Node
-        uses: actions/setup-node@v6.0.0
+        uses: actions/setup-node@v6.1.0
       - name: Bootstrap
         run: script/bootstrap
         env:

script/html-proofer

@@ -1,8 +1,32 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# ---------------------------------------------------------
+# HTMLProofer Runner Script
+# ---------------------------------------------------------
+# This script checks the generated static site (usually from
+# Jekyll or another static site generator) for:
+#   - Broken links
+#   - Invalid HTML
+#   - Missing OpenGraph tags
+#   - Missing favicons
+#   - 4xx link errors
+#
+# HTMLProofer helps ensure the built website is clean,
+# accessible, and free of broken external/internal links.
+#
+# This version adds clear comments and formatting to make
+# it easier for contributors to understand and maintain.
+# ---------------------------------------------------------
 
 require "bundler/setup"
 require "html-proofer"
 
+# ---------------------------------------------------------
+# URLs & patterns to ignore during link checking.
+# Some websites block automated requests, cause false
+# positives, or frequently return rate-limit errors.
+# ---------------------------------------------------------
 url_ignores = [
   "https://okdistribute.xyz/post/okf-de",
   "https://www.drupal.org/community-initiatives/drupal-core/usability",
@@ -15,7 +39,9 @@ url_ignores = [
   "https://stackoverflow.com/questions/18664074/",
   "http://geekfeminism.wikia.com/wiki/Meritocracy",
   "https://news.ycombinator.com/item?id=7531689",
-  %r{^https?://stackoverflow\.com/questions/18664074/getting-error-peer-authentication-failed-for-user-postgres-when-(trying-)?to-ge},
+
+  # Regex patterns for broader ignore rules
+  %r{^https?://stackoverflow\.com/questions/18664074/},
   %r{^https?://readwrite\.com/2014/10/10/open-source-diversity-how-to-contribute/},
   %r{^https?://twitter\.com/},
   %r{^https?://(www\.)?kickstarter\.com/},
@@ -29,17 +55,20 @@ url_ignores = [
   %r{^https?://(www\.)?medium\.com},
 ]
 
+# ---------------------------------------------------------
+# Run HTMLProofer with project-specific settings
+# ---------------------------------------------------------
 HTMLProofer::Runner.new(
-  ["_site"],
-  parallel: { in_threads: 4 },
+  ["_site"],                        # Directory containing the generated site
+  parallel: { in_threads: 4 },      # Speed up checks using 4 threads
   type: :directory,
-  ignore_urls: url_ignores,
-  check_html: true,
-  check_opengraph: true,
-  favicon: true,
-  assume_extension: true,
-  allow_missing_href: true,
-  enforce_https: false,
-  only_4xx: true,
-  ignore_status_codes: [429]
+  ignore_urls: url_ignores,         # Skip known-problematic URLs
+  check_html: true,                 # Validate HTML structure
+  check_opengraph: true,            # Check for OpenGraph tags
+  favicon: true,                    # Ensure favicon exists
+  assume_extension: true,           # Allow links without file extensions
+  allow_missing_href: true,         # Don't fail on <a> tags with no href
+  enforce_https: false,             # Allow HTTP links
+  only_4xx: true,                   # Only report 4xx errors from external URLs
+  ignore_status_codes: [429]        # Ignore Too Many Requests (rate-limit)
 ).run