Repository navigation
docs: bring README, docs site, notebook, and llms exports up to date with v1.1/v1.2 - #172
Merged
Merged
Conversation
…with v1.1/v1.2 Post-release freshness pass: - README: banner points at v1.2; new "What's New in v1.2" and "v1.1" sections; feature table/bullets and the Structured Output section reflect native json_schema, structured_status, and the four guardrail stages; example table rows 23/29 updated; test count 7,796 -> 7,788. - docs/index.md: Guardrails card lists the four stages + observer events. - docs/ARCHITECTURE.md: agent responsibilities and the structured.py section reflect native mode, StructuredOutputConfig, structured_status. - docs/COOKBOOK.md: the Guardrails Pipeline recipe was broken (five invalid kwargs; it never worked as written) - rewritten against the real API (validated by executing it) and extended with the tool-boundary stages. - docs/QUICKSTART.md: guardrails intro points at the four stages. - notebooks/getting_started.ipynb: guardrails cell mentions the four stages and on_guardrail_triggered; pre-existing lint debt in the notebook cleaned (ruff B905 + auto-fixes) since re-serialization put it in lint scope. - docs/llms-full.txt regenerated via scripts/build_llms_full.py. Claude-Session: https://claude.ai/code/session_01L1JWChKMs9yTyK92qquhJa
This was referenced Jul 14, 2026
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.
Post-release docs freshness pass after v1.1.0 and v1.2.0:
structured_status/ four-stage guardrails; example-table rows for 23 and 29; test count corrected to the current collected 7,788.structured.pysection updated.GuardrailsPipeline(guardrails=...),GuardrailAction.REDACT,LengthGuardrail(max_length=...),TopicGuardrail(blocked_topics=...),AgentConfig(guardrails=GuardrailsConfig(...))— it never worked as written). Rewritten against the real API and executed to verify; extended with the tool-boundary stages.scripts/build_llms_full.py.docs/llms.txt, GUARDRAILS.md, AGENT.md, CHANGELOG, and the example scripts were already updated in the feature PRs.
https://claude.ai/code/session_01L1JWChKMs9yTyK92qquhJa