Skip to content

v0.10.2 - ship docs/guide/ in gem (fixes 'no docs in gem' for LLM agents)

Choose a tag to compare

View all tags
@justi justi released this 10 Jun 15:14
· 5 commits to main since this release
v0.10.2
d7e89e7

Patch release: docs/guide/* now ships inside the gem. No code behavior change vs 0.10.1.

Why this matters

LLM integration agents (Cursor, Claude Code, Copilot) integrating the gem locally reported "no documentation in the gem" because the README's See also links pointed at docs/guide/getting_started.md, docs/guide/optimizing_retry_policy.md, etc. - but those files were stripped from the published gem by the spec.files reject f.start_with?("docs/") filter.

After upgrading to 0.10.2: bundle show ruby_llm-contract and gem unpack ruby_llm-contract both expose the full docs/guide/ directory locally, so agents can read the manuals without an internet round-trip to GitHub.

Added

  • docs/guide/* packaged with the gem (14 manuals, ~120 KB): getting_started, optimizing_retry_policy, eval_first, pipeline, multimodal_input, output_schema, rails_integration, testing, best_practices, why, migration, prompt_ast, relation_to_agent, relation_to_tribunal. Plus docs/architecture.md. docs/ideas/ (brainstorming) and doc/decisions/ (ADRs) remain excluded.

Fixed

  • models: keyword form documented + pinned for hash configs. retry_policy models: ["gpt-5-nano", { model: "gpt-5-mini", reasoning_effort: "high" }] is now covered by a spec and shown in getting_started.md.
  • reasoning_effort examples corrected to gpt-5 family. Pre-0.10.2 docs and specs paired reasoning_effort with gpt-4.1-* model names, which is incorrect: gpt-4.1 is not a reasoning model. Updated across getting_started, optimizing_retry_policy, CHANGELOG, and 7 spec files. Non-reasoning gpt-4.1 fallback examples (without reasoning_effort) are unchanged.
  • Stale version mentions in README + multimodal guide. README FAQ ("Upgraded to 0.9.0 — why?") now reads "Upgraded to 0.10.0 from 0.8.x"; multimodal_input.md references 0.10.0+ / 0.10.x instead of 0.9.0. (0.9.0 and 0.9.1 were tagged but never published to rubygems; adopters jump from 0.8.0 directly to 0.10.x.)

Notes

  • Suite: 1402 examples / 0 failures / 7 pending (unchanged from 0.10.1).
  • 0.10.1 stays live on rubygems (not yanked) — functionally identical to 0.10.2; the only difference is docs visibility inside the gem.

Full diff: v0.10.1...v0.10.2

Assets 2
Loading