docs: sync user docs with shipped 0.4 features (3-6)#25
Merged
Conversation
- Drop the '0.3.0' version from the status line (pyproject is source of truth) - Drop the now-false 'retry / timeout / bulkhead not yet shipped' claim - Mention the resilience suite (Retry + RetryBudget, Bulkhead) in the project description - Add a 'With resilience middleware' Quickstart subsection showing the recommended [Bulkhead, Retry] ordering - Add an 'Errors' section so users know StatusError / NetworkError / RetryBudgetExhaustedError / BulkheadFullError exist - Replace the dead readthedocs.io link with the GH Releases page
- Drop '0.1.0 alpha' from the status line - Rewrite the project description (pre-v0.2 wording claimed 'owns the abstraction layer / consumers never import the transport' — both walked back in v0.2) - Add the pydantic extra to the install block (was added in 0.3.0) - Add a 'With resilience middleware' subsection mirroring the README - Add an 'Errors' section - Fix the dead 'Engineering Notes' link (target file doesn't exist in docs/ tree; point to GH URL of planning/engineering.md instead) - Fix the now-incorrect 'five protocol seams' claim (v0.2 collapsed to three) - Add a Release notes link
- Remove 'No import httpx2 outside transports/httpx2.py' — retired in the v0.2 thin-wrapper pivot; transports/ directory no longer exists. Continuing to list this rule misleads contributors. - Add 'Type suppressions use # ty: ignore[<rule>]' — current CI-enforced invariant that was missing from this list.
The file doesn't exist (the live engineering reference is planning/engineering.md). mkdocs build --strict was emitting a 'file referenced in nav not found' warning. Drop the broken entry; docs/index.md now links to the GH URL of planning/engineering.md. site_url left as-is (fictional RTD URL is unrelated project hygiene to be addressed separately).
- §1: append a sentence noting the resilience suite ships in 0.4 - §5: add middleware/resilience/ subpackage (bulkhead, budget, retry, _backoff) to the module tree; extend errors.py comment to mention NetworkError + RetryBudgetExhaustedError + BulkheadFullError
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
Closes Epic 3 with story 3-6 (re-scoped from "extension-slot tutorial" to "sync user docs with shipped features"). Five files updated to match what's actually on main (Retry, RetryBudget, Bulkhead, NetworkError, RetryBudgetExhaustedError, BulkheadFullError). No source/test changes.
Test Plan
Refs
🤖 Generated with Claude Code