llms-txt-ruby 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57be54434134c87cc4939264861e7e64f1b721aeef9e52ebe11080b3f1ab08d1
+  data.tar.gz: d413c3a1902cd259f9af274aefbcaf65df9714ba7e6ae958de2afc30101b4778
+SHA512:
+  metadata.gz: 43ab2bcc770fb9f0486363b4904f006d6b462a6adfae1b9e7d05d8a1aed5c2b4356f02ca2737ca4c6e1d0a333f132d621d5cbb1033a28afcff8c8bafcd690b4a
+  data.tar.gz: ba760b69ca401f1b3cf0e5ec14a9e76bef92e86c5804a040b03b203aa6af1e39361cbe8fb5e8fbb84ecbf48d557cb3ccd49e194f0e7e2eaeb872f0f7f07a171b

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Maciej Mensfeld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# llms-txt-ruby
+
+> ⚠️ **Work in Progress** - This gem is currently under active development and not yet ready for any use.
+
+A Ruby gem that automatically generates [llms.txt](https://llmstxt.org/) files for Ruby projects using AI. This gem analyzes your Ruby codebase, extracts documentation from YARD comments, README files, and gemspec metadata, then uses a Large Language Model to create a properly formatted llms.txt file following the official specification.
+
+## What is llms.txt?
+
+The llms.txt file is a proposed standard for providing LLM-friendly content on websites. It offers brief background information, guidance, and links to detailed markdown files, helping Large Language Models understand and navigate your project more effectively.
+
+Learn more at [llmstxt.org](https://llmstxt.org/).
+
+## Features
+
+- 🤖 **AI-powered generation**: Uses Claude or GPT models to create natural, comprehensive llms.txt files
+- 📚 **YARD integration**: Extracts rich documentation from YARD comments and tags
+- 🔧 **Configurable**: Supports multiple LLM providers and customizable options
+- 🖥️ **CLI + API**: Use from command line or integrate into your Ruby applications
+- 📁 **Project awareness**: Understands Ruby project structure and conventions
+- 🎯 **Spec compliant**: Generates files that strictly follow the llms.txt specification
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'llms-txt-ruby'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install llms-txt-ruby
+```
+
+## Example Output
+
+Here's what a generated llms.txt file might look like:
+
+```markdown
+# MyAwesomeGem
+
+> MyAwesomeGem is a Ruby library for processing data with advanced algorithms and providing a clean API for developers.
+
+This gem provides a comprehensive toolkit for data processing, featuring both synchronous and asynchronous processing capabilities. It includes built-in caching, error handling, and extensive configuration options.
+
+## Documentation
+
+- [Getting Started Guide](docs/getting_started.md): Quick introduction and basic usage examples
+- [API Documentation](https://rubydoc.info/gems/my_awesome_gem): Complete API reference
+- [Configuration Guide](docs/configuration.md): Detailed configuration options
+
+## Examples
+
+- [Basic Usage Examples](examples/basic_usage.rb): Simple examples to get started
+- [Advanced Patterns](examples/advanced_patterns.rb): Complex usage patterns and best practices
+
+## Optional
+
+- [Contributing Guidelines](CONTRIBUTING.md): How to contribute to this project
+- [Changelog](CHANGELOG.md): Version history and changes
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+Made with ❤️ for the Ruby community

data/lib/llms-txt/version.rb

@@ -0,0 +1,3 @@
+module LLMsTxt
+  VERSION = '0.0.0'
+end

data/llms-txt-ruby.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/llms-txt/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'llms-txt-ruby'
+  spec.version = LLMsTxt::VERSION
+  spec.authors = ['Maciej Mensfeld']
+  spec.email = %w[maciej@mensfeld.pl]
+
+  spec.summary = 'Ruby implementation of the llms.txt specification for LLM-friendly content'
+  spec.description = <<~DESC
+    A Ruby gem that implements the llms.txt specification, providing tools to create and manage
+    llms.txt markdown files for websites. These files help Large Language Models understand
+    and navigate website content more effectively by providing curated, LLM-friendly information
+    in a standardized format.
+  DESC
+
+  spec.homepage = 'https://github.com/mensfeld/llms-txt-ruby'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mensfeld/llms-txt-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/mensfeld/llms-txt-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://github.com/mensfeld/llms-txt-ruby'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: llms-txt-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Maciej Mensfeld
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A Ruby gem that implements the llms.txt specification, providing tools to create and manage
+  llms.txt markdown files for websites. These files help Large Language Models understand
+  and navigate website content more effectively by providing curated, LLM-friendly information
+  in a standardized format.
+email:
+- maciej@mensfeld.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/llms-txt/version.rb
+- llms-txt-ruby.gemspec
+homepage: https://github.com/mensfeld/llms-txt-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mensfeld/llms-txt-ruby
+  source_code_uri: https://github.com/mensfeld/llms-txt-ruby
+  changelog_uri: https://github.com/mensfeld/llms-txt-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/mensfeld/llms-txt-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Ruby implementation of the llms.txt specification for LLM-friendly content
+test_files: []