Docs: fix GitHub Pages build and add related links

.github/workflows/docs.yml

@@ -29,6 +29,12 @@ jobs:
       - name: Setup Pages
         uses: actions/configure-pages@v6
 
+      - name: Copy root docs into the Jekyll includes
+        run: |
+          mkdir -p docs/_includes
+          cp CHANGELOG.md docs/_includes/CHANGELOG.md
+          cp CONTRIBUTING.md docs/_includes/CONTRIBUTING.md
+
       - name: Build with Jekyll
         uses: actions/jekyll-build-pages@v1
         with:

.gitignore

@@ -32,3 +32,5 @@ analysis_report.html
 
 # GoReleaser
 dist/
+docs/_includes/CHANGELOG.md
+docs/_includes/CONTRIBUTING.md

docs/ARCHITECTURE.md

@@ -3,6 +3,7 @@ layout: default
 title: Architecture
 nav_order: 2
 ---
+{% raw %}
 
 # kshark Architecture Overview
 
@@ -1212,3 +1213,4 @@ The layered testing approach ensures thorough validation of all connectivity com
 **Author:** kshark Development Team
 **Last Review:** 2026-03-26
 **Next Review:** 2026-06-26
+{% endraw %}

docs/DEPLOYMENT.md

@@ -3,6 +3,7 @@ layout: default
 title: Deployment
 nav_order: 4
 ---
+{% raw %}
 
 # kshark Deployment Guide
 
@@ -1196,3 +1197,4 @@ This deployment guide provides comprehensive strategies for running kshark acros
 **Author:** kshark Development Team
 **Last Review:** 2025-11-13
 **Next Review:** 2025-12-13
+{% endraw %}

docs/_config.yml

@@ -19,11 +19,13 @@ color_scheme: dark
 aux_links:
   "GitHub":
     - "https://github.com/scalytics/kshark-core"
+  "Scalytics open source":
+    - "https://www.scalytics.io/open-source"
 
 aux_links_new_tab: true
 
 # Footer
-footer_content: "Copyright © 2024-2026 Scalytics GmbH. Licensed under Apache 2.0."
+footer_content: "Copyright &copy; 2024-2026 Scalytics GmbH. Licensed under Apache 2.0. <a href=\"https://github.com/scalytics/kshark-core\">Source on GitHub</a> · <a href=\"https://www.scalytics.io/open-source\">Scalytics open source</a>"
 
 # Back to top link
 back_to_top: true
@@ -34,6 +36,8 @@ heading_anchors: true
 
 # Exclude from build
 exclude:
+  - Gemfile
+  - Gemfile.lock
   - .DS_Store
   - images/.DS_Store
   - SSRF_FIX_GUIDE.md

docs/acceptance-protocol.md

@@ -3,6 +3,7 @@ layout: default
 title: Acceptance Protocol
 nav_order: 3.5
 ---
+{% raw %}
 
 # Post-Deployment Acceptance Protocol
 
@@ -387,3 +388,4 @@ sha256sum report.json
 **Document Version:** 1.0
 **Author:** kshark Development Team
 **Last Review:** 2026-03-27
+{% endraw %}

docs/changelog.md

@@ -4,5 +4,5 @@ title: Changelog
 nav_order: 9
 ---
 
-{% capture content %}{% include_relative ../CHANGELOG.md %}{% endcapture %}
+{% capture content %}{% include CHANGELOG.md %}{% endcapture %}
 {{ content }}

docs/contributing.md

@@ -4,5 +4,5 @@ title: Contributing
 nav_order: 8
 ---
 
-{% capture content %}{% include_relative ../CONTRIBUTING.md %}{% endcapture %}
+{% capture content %}{% include CONTRIBUTING.md %}{% endcapture %}
 {{ content }}

docs/index.md

@@ -17,14 +17,14 @@ kshark acts like a network sniffer for Kafka, providing comprehensive health che
 
 | Document | Description |
 |----------|-------------|
-| [Architecture]({% link ARCHITECTURE.md %}) | System architecture, components, and design patterns |
-| [Features]({% link FEATURES.md %}) | Complete feature list and configuration reference |
-| [Deployment]({% link DEPLOYMENT.md %}) | Docker, Kubernetes, and CI/CD deployment guides |
-| [Security]({% link SECURITY.md %}) | Security audit, OWASP analysis, and hardening |
-| [Release Notes]({% link RELEASE.md %}) | Release history and upgrade notes |
-| [Connector Probe]({% link connector-probe.md %}) | Probing MongoDB, PostgreSQL, and DB2 targets |
-| [Contributing]({% link contributing.md %}) | How to contribute to kshark |
-| [Changelog]({% link changelog.md %}) | Detailed change log |
+| [Architecture](ARCHITECTURE.md) | System architecture, components, and design patterns |
+| [Features](FEATURES.md) | Complete feature list and configuration reference |
+| [Deployment](DEPLOYMENT.md) | Docker, Kubernetes, and CI/CD deployment guides |
+| [Security](SECURITY.md) | Security audit, OWASP analysis, and hardening |
+| [Release Notes](RELEASE.md) | Release history and upgrade notes |
+| [Connector Probe](connector-probe.md) | Probing MongoDB, PostgreSQL, and DB2 targets |
+| [Contributing](contributing.md) | How to contribute to kshark |
+| [Changelog](changelog.md) | Detailed change log |
 
 ---
 
@@ -70,4 +70,14 @@ Diagnostics       Traceroute, MTU discovery, network path analysis
 
 ---
 
-Built with care for the Kafka community by [Scalytics](https://scalytics.io).
+## Related projects
+
+kshark-core is also an example of how agents can use our tools to debug Kafka clusters: the JSON reports are built for scripts and AI agents to read.
+
+- [KafClaw](https://github.com/KafClaw/KafClaw): agent runtime in Go that connects AI agents through Kafka topics. It ships a `kafclaw kshark` command for Kafka diagnostics.
+- [KafScale](https://kafscale.io/): Kafka-compatible streaming that keeps the log in S3.
+- [kaf-mirror](https://github.com/scalytics/kaf-mirror): Kafka-to-Kafka replication with a web dashboard, REST API and CLI.
+
+Source code: [github.com/scalytics/kshark-core](https://github.com/scalytics/kshark-core). All Scalytics open source projects: [scalytics.io/open-source](https://www.scalytics.io/open-source).
+
+Built with care for the Kafka community by [Scalytics](https://www.scalytics.io).