Skip to content

Improve README DX: value prop, troubleshooting, table cleanup#79

Merged
shayc merged 1 commit into
mainfrom
docs/readme-dx-pass
Jul 6, 2026
Merged

Improve README DX: value prop, troubleshooting, table cleanup#79
shayc merged 1 commit into
mainfrom
docs/readme-dx-pass

Conversation

@shayc

@shayc shayc commented Jul 6, 2026

Copy link
Copy Markdown
Owner

Summary

  • Rewrite the intro to lead with what the hooks remove (manual availability probing, activation-gated downloads, progress wiring, cleanup, dedup) instead of just describing the architecture; scope the Gemini Nano mention correctly to the Prompt/writing APIs
  • Add a lifecycle state-flow diagram and a symptom-keyed Troubleshooting subsection (unsupported / unavailable / stuck on downloadable)
  • Fold the Requirements table into Install (React peer dep + "use client" note); add a Chrome-version column to the API table so the Prompt API's later support window (148+ vs 138+) is visible without a footnote
  • Reorder lifecycle bullets so the headline fact comes first and cross-tab/edge-case nuance follows; split run-on sentences; add section headings for Streaming and rename ambiguous headings ("Surface" → "API", "Usage" → "Handling the lifecycle in UI")
  • Fix the quick start to actually feature-detect, per the doc's own advice

Test plan

  • npx prettier --check README.md passes
  • All internal anchor links (#api, #capability-check, #lifecycle, #prompt-api) verified to resolve
  • No code changes — docs only

🤖 Generated with Claude Code

Rewrites the intro around the problem the hooks solve, adds a
symptom-keyed troubleshooting section, folds Requirements into
Install, and adds a Chrome-version column to the API table so the
Prompt API's later support window is visible at a glance.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@shayc shayc merged commit 96717fb into main Jul 6, 2026
2 checks passed
@shayc shayc deleted the docs/readme-dx-pass branch July 6, 2026 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant