Module: LlmDocsBuilder::Errors

Defined in:

lib/llm_docs_builder/errors.rb

Overview

Namespace used to encapsulate all the internal errors of LlmDocsBuilder

Constant Summary

BaseError =

Base class for all the LlmDocsBuilder internal errors

Class.new(StandardError)

GenerationError =

Raised when llms.txt generation fails due to configuration issues, missing directories, invalid YAML, or file access problems

Examples:

When directory doesn’t exist

LlmDocsBuilder.bulk_transform('/nonexistent/path')
# => raises GenerationError: "Directory not found: /nonexistent/path"

When config YAML is invalid

LlmDocsBuilder.generate_from_docs(config_file: 'invalid.yml')
# => raises GenerationError: "Invalid YAML in config file..."

Class.new(BaseError)

ValidationError =

Raised when llms.txt content validation fails

This error is intended for validation failures but currently not used. The Validator class returns boolean results instead of raising errors.

Examples:

Future usage (when validation raises)

LlmDocsBuilder.validate!(invalid_content)
# => raises ValidationError: "Missing required H1 title"

Class.new(BaseError)