Skip to content

Commit 26e1893

Browse files
lesnik512claude
andcommitted
docs(planning): mark docs-UX findings resolved + index the bundle
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 8b5de01 commit 26e1893

2 files changed

Lines changed: 18 additions & 10 deletions

File tree

planning/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ carry **no** frontmatter — living prose, dated by git.
7070

7171
### Active
7272

73-
_None._
73+
- **[docs-ux-restructure](changes/active/2026-06-14.01-docs-ux-restructure/design.md)** (draft, 2026-06-14) — Thin README front-door + canonical `docs/index.md`, why-httpware hook (G1), runnable first example (G4), nav nits, base-client scrub. G2 dropped, G6 deferred.
7474

7575
### Archived (shipped)
7676

planning/audits/2026-06-13-docs-audit.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -125,17 +125,20 @@ accompanying change.
125125
- **G1 — No "why httpware".** Both README and index lead with "thin wrapper over
126126
httpx2" + a feature list. The actual selling points (typed errors without
127127
`raise_for_status()`; typed bodies via `response_model=`) are buried mid-page.
128-
*Suggest:* a 3-bullet "Why httpware" block up top.
129-
- **G2 — No base-client migration guide.** httpware explicitly supersedes
130-
community-of-python/base-client, yet that inbound audience has zero signpost in
131-
the user docs. *Suggest:* `docs/migration-from-base-client.md`.
128+
**Resolved** (`2026-06-14.01`) — 3-bullet "Why httpware" block added to the top
129+
of both README and `docs/index.md`.
130+
- **G2 — No base-client migration guide.** **Won't do** (`2026-06-14.01`) — per
131+
the maintainer, base-client is scrubbed entirely, not documented; the lone live
132+
mention (`CLAUDE.md`) was removed and no migration guide is written.
132133
- **G3 — README ↔ index.md ~70% duplicated**, including the entire observability
133-
contract table — guaranteed to drift on the next logger/event change. *Suggest:*
134-
one canonical home (docs/); README becomes value-prop + install + one quickstart
135-
+ links.
134+
contract table — guaranteed to drift on the next logger/event change. **Resolved**
135+
(`2026-06-14.01`) — README slimmed to a front-door (why + install + one runnable
136+
quickstart + links); `docs/index.md` is now the single canonical home for the
137+
full quickstart/resilience/streaming/errors/observability content.
136138
- **G4 — First quickstart hits `https://example.test`**, which resolves to
137-
nothing — a newcomer's first paste yields `NetworkError`, not data. *Suggest:* a
138-
real public test endpoint for the leading example.
139+
nothing — a newcomer's first paste yields `NetworkError`, not data. **Resolved**
140+
(`2026-06-14.01`) — leading examples (README + `docs/index.md`) now hit
141+
`jsonplaceholder.typicode.com/users/1`; verified to return a decoded `User` live.
139142
- **G5 — `STATUS_TO_EXCEPTION` is a public `__all__` export
140143
(`src/httpware/__init__.py:54`) documented nowhere.** The lone undocumented
141144
public symbol. **Resolved** (`2026-06-13.05`) — documented at the
@@ -151,6 +154,11 @@ Navigation nits (LOW): mkdocs nav orders Resilience before Middleware though
151154
Resilience is built on it and forward-references it; several `architecture/*.md`
152155
references in published pages are bare paths, not links, so a site reader cannot
153156
follow them. No orphan pages and no broken nav targets — the nav is otherwise clean.
157+
**Resolved** (`2026-06-14.01`) — nav reordered (Middleware before Resilience) and
158+
all five bare `architecture/*.md` references converted to absolute GitHub links.
159+
160+
Only **G6** (custom-`ResponseDecoder` guide; no API reference per maintainer)
161+
remains open after `2026-06-14.01`.
154162

155163
### Verified correct (negative results)
156164

0 commit comments

Comments
 (0)