llm-docs-builder 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8104ee730f22ce1c3ff1f13dea2e784e82b617ea5c20332185351922c1d75710
-  data.tar.gz: 4cc077637f04d658a35b97aee35aed031f27c44a59f87d961e64af4aed268f77
+  metadata.gz: 7f0653d0b7cbe76ef97429cd96ebf225783d2d454c765346c1c13279b73b7527
+  data.tar.gz: 206472b3a91c477827c3adeb73679758ebe1b3d73b47ef9c60a04afcce183c79
 SHA512:
-  metadata.gz: 22c9b908b4473c8207027107f68c85fc7a8751d459a781ba67bcebc4034da5dcd8b0d748c1931b78b9e7d3ee891ac9f814350fb052930d1715fc38fb0e870eae
-  data.tar.gz: 6dea4a2987218ca92c9eb0162460870a15cdf24a0feaca559e31d734075d40be1da46186d437ccde47bf5cc0c9b2d2784180625fb0754926d0e1c7baf6708e86
+  metadata.gz: eca112eb185027b8fd905d062d1abf54ed147025d16608176aae6ee6caf836af658d66bb315f5e11137d109e10fb6fce85aedd6d730afbafd9379c49061e1bbd
+  data.tar.gz: 2b6b7c2227e1b3926378238f743825b36f350cbfa97abaffad2a26e1061063e6185eafb18762152c1174cbcd3dd1c7132cce6affc1b2cbf1ad19be8eda83dfc0

data/.github/workflows/docker.yml

@@ -79,7 +79,7 @@ jobs:
       - name: Test Docker image
         run: |
           docker run --rm ${{ fromJSON(steps.meta.outputs.json).tags[0] }} version
-          docker run --rm ${{ fromJSON(steps.meta.outputs.json).tags[0] }} --help
+          docker run --rm ${{ fromJSON(steps.meta.outputs.json).tags[0] }} generate --help
 
   docker-success:
     name: Docker Success

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.9.0 (2025-10-17)
+- [Feature] **No AI Version Detection** - The `compare` command now detects when websites don't serve AI-optimized versions.
+  - Triggers when reduction is <5% (nearly identical content for human and AI User-Agents)
+  - Displays prominent warning: "WARNING: NO DEDICATED AI VERSION DETECTED"
+  - Shows potential savings estimates based on typical 83% reduction rate
+  - Provides page-specific calculations (estimated token savings, potential size)
+  - Includes implementation guide with actionable steps
+  - Helps identify opportunities to optimize documentation
+- [Enhancement] Updated `OutputFormatter#display_comparison_results` to include marketing message for unoptimized sites.
+- [Enhancement] Added utility script `probe_karafka_simple.rb` for batch comparison testing.
+
+## 0.8.2 (2025-10-17)
+- [Fix] Fixed Docker workflow test to properly invoke help command (use `generate --help` instead of `--help`).
+
 ## 0.8.1 (2025-10-17)
 - [Enhancement] Ship the docker container.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    llm-docs-builder (0.8.1)
+    llm-docs-builder (0.9.0)
       zeitwerk (~> 2.6)
 
 GEM

data/README.md

@@ -1,3 +1,7 @@
+<p align="center">
+  <img src="misc/logo_wide.png" alt="llm-docs-builder logo">
+</p>
+
 # llm-docs-builder
 
 [![CI](https://github.com/mensfeld/llm-docs-builder/actions/workflows/ci.yml/badge.svg)](
@@ -438,10 +442,6 @@ generate_toc: true
 normalize_whitespace: true
 ```
 
-## Contributing
-
-Bug reports and pull requests welcome at [github.com/mensfeld/llm-docs-builder](https://github.com/mensfeld/llm-docs-builder).
-
 ## License
 
 Available as open source under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/llm_docs_builder/output_formatter.rb

@@ -8,6 +8,8 @@ module LlmDocsBuilder
   #
   # @api private
   class OutputFormatter
+    # Threshold percentage below which we consider there's no AI-optimized version
+    NO_AI_VERSION_THRESHOLD = 5
     # Format bytes into human-readable string
     #
     # @param bytes [Integer] number of bytes
@@ -56,10 +58,16 @@ module LlmDocsBuilder
 
       if result[:reduction_bytes].positive?
         display_reduction(result)
+
+        # Detect if there's no dedicated AI version
+        if result[:reduction_percent] < NO_AI_VERSION_THRESHOLD
+          display_no_ai_version_message(result)
+        end
       elsif result[:reduction_bytes].negative?
         display_increase(result)
       else
         puts 'Same size'
+        display_no_ai_version_message(result)
       end
 
       puts '=' * 60
@@ -89,5 +97,43 @@ module LlmDocsBuilder
       puts "Token increase: #{format_number(token_increase)} tokens (#{token_increase_percent}%)"
       puts "Factor:         #{result[:factor]}x larger"
     end
+
+    # Display message when no dedicated AI version is detected
+    #
+    # @param result [Hash] comparison results
+    # @api private
+    def self.display_no_ai_version_message(result)
+      puts ''
+      puts 'WARNING: NO DEDICATED AI VERSION DETECTED'
+      puts ''
+      puts 'The server is returning nearly identical content to both human and AI'
+      puts 'User-Agents, indicating no AI-optimized version is currently served.'
+      puts ''
+      puts 'POTENTIAL SAVINGS WITH AI OPTIMIZATION:'
+      puts ''
+      puts 'Based on typical documentation optimization results, you could expect:'
+      puts '  • 67-95% token reduction (average 83%)'
+      puts '  • 3-20x smaller file sizes'
+      puts '  • Faster LLM processing times'
+      puts '  • Reduced API costs for AI queries'
+      puts '  • Improved response accuracy'
+      puts ''
+      puts "For this page specifically (~#{format_number(result[:human_tokens])} tokens):"
+      puts "  • Estimated savings: ~#{format_number((result[:human_tokens] * 0.83).round)} tokens (83% reduction)"
+      puts "  • Could reduce to: ~#{format_number((result[:human_tokens] * 0.17).round)} tokens"
+      puts "  • Potential size: ~#{format_bytes((result[:human_size] * 0.17).round)}"
+      puts ''
+      puts 'HOW TO IMPLEMENT AI-OPTIMIZED DOCUMENTATION:'
+      puts ''
+      puts '1. Transform your docs with llm-docs-builder:'
+      puts '   llm-docs-builder bulk-transform --docs ./docs --config llm-docs-builder.yml'
+      puts ''
+      puts '2. Configure your web server to serve .md files to AI bots:'
+      puts '   See: https://github.com/mensfeld/llm-docs-builder#serving-optimized-docs'
+      puts ''
+      puts '3. Measure your actual savings:'
+      puts '   llm-docs-builder compare --url <your-url> --file <local-md>'
+      puts ''
+    end
   end
 end

data/lib/llm_docs_builder/version.rb

@@ -2,5 +2,5 @@
 
 module LlmDocsBuilder
   # Current version of the LlmDocsBuilder gem
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm-docs-builder
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -147,6 +147,8 @@ files:
 - lib/llm_docs_builder/version.rb
 - llm-docs-builder.gemspec
 - llm-docs-builder.yml.example
+- misc/logo.png
+- misc/logo_wide.png
 - renovate.json
 homepage: https://github.com/mensfeld/llm-docs-builder
 licenses: