Skip to content

Commit 8b5de01

Browse files
lesnik512claude
andcommitted
docs: link bare architecture/*.md references to GitHub source
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent f33a208 commit 8b5de01

4 files changed

Lines changed: 5 additions & 5 deletions

File tree

docs/errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,4 +191,4 @@ Unlike `DecodeError`, this error fires *before* the HTTP request — no traffic
191191

192192
- **[Resilience reference](resilience.md)**`AsyncRetry`, `RetryBudget`, `AsyncBulkhead` parameter tables.
193193
- **[Middleware guide](middleware.md)** — the `@async_on_error` decorator can translate exceptions into responses.
194-
- **`architecture/errors.md`** — the formal exception contract.
194+
- **[`architecture/errors.md`](https://github.com/modern-python/httpware/blob/main/architecture/errors.md)** — the formal exception contract.

docs/middleware.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ The example pairs naturally with the 0.6.0 observability events: a `httpware.ret
110110
- **Redaction:** Use a `logging.Filter` on the consumer side. `httpware` deliberately does no redaction in-library (per the 0.6.0 observability design).
111111
- **URL or header validation:** `httpx2` owns it. Don't reimplement.
112112
- **Per-call behavior that doesn't apply to other calls:** Pass through `request.extensions=` (or the `extensions=` kwarg at the call site) instead. Middleware exists for *cross-cutting* concerns.
113-
- **HTTP-level span creation for tracing:** Install `opentelemetry-instrumentation-httpx` instead of writing an OTel middleware in httpware. We retired story `5-4` (standalone OTel middleware) for this reason — `opentelemetry-instrumentation-httpx` already covers transport-level tracing, and a separate httpware layer would duplicate it. See `architecture/middleware.md`.
113+
- **HTTP-level span creation for tracing:** Install `opentelemetry-instrumentation-httpx` instead of writing an OTel middleware in httpware. We retired story `5-4` (standalone OTel middleware) for this reason — `opentelemetry-instrumentation-httpx` already covers transport-level tracing, and a separate httpware layer would duplicate it. See [`architecture/middleware.md`](https://github.com/modern-python/httpware/blob/main/architecture/middleware.md).
114114

115115
## Wiring OpenTelemetry
116116

@@ -198,6 +198,6 @@ Sync and async middleware classes do not interop: a `Middleware` cannot be passe
198198

199199
## See also
200200

201-
- **`architecture/middleware.md` (Seam A)** — the formal protocol contract and why the chain is frozen at construction.
201+
- **[`architecture/middleware.md`](https://github.com/modern-python/httpware/blob/main/architecture/middleware.md) (Seam A)** — the formal protocol contract and why the chain is frozen at construction.
202202
- **`src/httpware/middleware/resilience/`**`AsyncRetry`, `AsyncBulkhead`, `RetryBudget` as real-world consumers of this exact protocol.
203203
- **[Quick-Start composition example](index.md#with-resilience-middleware)** — composing built-in middleware.

docs/resilience.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,4 +358,4 @@ with Client(
358358
- **[Middleware guide](middleware.md)** — write your own resilience middleware against the same protocol `AsyncRetry` and `AsyncBulkhead` use.
359359
- **[Errors reference](errors.md)**`RetryBudgetExhaustedError`, `BulkheadFullError`, `CircuitOpenError`, and the broader exception tree.
360360
- **[Observability](index.md#observability)** — the operational events these middleware emit.
361-
- **`architecture/middleware.md`** — the formal Middleware/Seam-A contract.
361+
- **[`architecture/middleware.md`](https://github.com/modern-python/httpware/blob/main/architecture/middleware.md)** — the formal Middleware/Seam-A contract.

docs/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,4 @@ For middleware with state-keeping (counters, circuit-breaker state), assert on i
111111

112112
- **[Middleware guide](middleware.md)** — write the middleware you're testing.
113113
- **[Resilience reference](resilience.md)** — testing `AsyncRetry`/`AsyncBulkhead` configurations.
114-
- **`architecture/testing.md`** — the project's own testing patterns (Hypothesis property-based tests, `pytest-asyncio` auto-mode, the `RecordedTransport`-was-removed history).
114+
- **[`architecture/testing.md`](https://github.com/modern-python/httpware/blob/main/architecture/testing.md)** — the project's own testing patterns (Hypothesis property-based tests, `pytest-asyncio` auto-mode, the `RecordedTransport`-was-removed history).

0 commit comments

Comments
 (0)