docs: README pass before 0.1.0 publish#13
Merged
joshrotenberg merged 1 commit intomainfrom Apr 18, 2026
Merged
Conversation
- Install snippet: bump gen_agent_anthropic constraint to ~> 0.2 (uses :receive_timeout from that version) - Strategies table note: point at the local workflow guides instead of the dead link to gen_agent's hexdocs; orchestration patterns live here now - Quickstart: reflect that `echo` is pre-enabled after the config re-comment (no manual edit needed to try it), and spell out the uncomment-then-restart path for real ensembles - Per-strategy guide pointer lists all 7 strategies, not just 4 - Status footer tightened: the op vocabulary and public API are stable ahead of 1.0, breaking changes bump minor - Development section adds the full pre-commit checklist that matches CI
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.
Summary
Pre-publish read-through of the main README.
Changes
gen_agent_anthropicconstraint bumped from~> 0.1to~> 0.2(needs:receive_timeoutfrom 0.2.0)hexdocs.pm/gen_agent's pattern guides, which doesn't reflect the current layering (orchestration patterns live in this repo now per the ensemble pattern direction). Rewired to point at our ownguides/workflows/overview.md.echois pre-enabled after chore: re-comment example ensembles in config/config.exs before publishing #2 — no manual config edit needed to try it. Spells out the uncomment-then-restart path for a real ensemble.Test plan
mix format --check-formattedcleanmix testgreen (86 tests)mix docsstill exits 0 (won't know about 22 warnings until docs: mix docs builds clean, zero warnings #12 merges)Closes #5