docs: UX restructure — thin README, canonical site, runnable example#60
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Why-httpware hook, one runnable typed quickstart against jsonplaceholder, and a Documentation links section. Full quickstart/resilience/streaming/ errors/observability detail now lives canonically in docs/index.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
lesnik512
added a commit
that referenced
this pull request
Jun 14, 2026
* chore(planning): archive shipped docs-ux-restructure bundle Shipped via #60; promote 2026-06-14.01 out of active/ (status: shipped, pr: 60). Index Active is now empty. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs(planning): defer the custom-ResponseDecoder guide (G6) Park audit finding G6 in deferred.md (Documentation) as demand-gated, and note the resolution in the audit report. Closes out the docs-audit register. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Closes the structural onboarding/UX findings from the docs audit. Design + plan:
planning/changes/active/2026-06-14.01-docs-ux-restructure/.What changed
docs/index.mdis its single canonical home. (−104 lines of README.)docs/index.md(byte-identical).https://jsonplaceholder.typicode.com/users/1instead of the no-resolveexample.test//users/42. Verified live: returns a decodedUser.architecture/*.mdreferences converted to absolute GitHub links (were unclickable on the site).CLAUDE.md(G2 dropped — no migration guide).G6 (custom-decoder guide) is deferred; no API reference, per decision.
Verification
mkdocs build --strict— clean (no broken refs)id=1 name='Leanne Graham'just lint— clean (no source touched)Test Plan
🤖 Generated with Claude Code