docs: a short front page, with the reference moved into docs/ - #19
Merged
Conversation
The example walked through writing a provider for a real service. A reader could not tell at a glance whether it was documentation for something the gem ships or a worked example of something it does not, and the name would have collided the day that service became a real provider -- which is exactly what happened to the previous version of this example, written against Google. Acme cannot collide with anything, and its endpoint and auth scheme are now generic enough that nobody will paste them expecting a reply.
Splits the 902-line README into a ~150-line front page (why, a run of small code examples, the provider table, features, installation) in the ruby_llm README's shape, and moves the reference material into docs/ split by subject: configuration, providers, caching, contracts, instrumentation, errors, how-it-works, and development/upgrading. All moved prose is carried verbatim; nothing is dropped.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README was 902 lines. It was accurate, and it was the first thing anyone evaluating this gem met: cache-key construction, three duck-type contracts and the provider-authoring guide all stood between the first example and the second.
Restructured on the shape
ruby_llmuses — a short front page that links out, rather than a manual that happens to open with a pitch.README.md: 902 → 151 lines. Why it exists, a run of small snippets in the order a reader meets them, the provider table, features, installation, and links.docs/: eight pages, 859 lines. configuration, providers, caching, contracts, instrumentation, errors, how-it-works, development.This was a move, not a rewrite. Every fact in the old README was verified, and several were established by running real APIs — LibreTranslate's
notranslatebehaviour was measured in Docker, DeepL's and Google's were checked live. Prose was carried across verbatim; only connective sentences between sections were cut. The one sanctioned compression is the Amazon and LibreTranslate caveats, shortened to a line each on the front page and kept in full indocs/providers.md.Also here: the custom-provider example is now a fictional
Acmeservice. It was written against a real one, which reads as documentation for something the gem ships and would collide the day that service becomes a real provider — which is exactly what happened to the previous version of the example, written against Google.Verification
TranslationDiff::Configuration.options; every:null-provider snippet executed rather than eyeballed.lib/ortest/touched.