Skip to content

Update README for accuracy and completeness - #422

Open
vliggio wants to merge 1 commit into
cloudflare:mainfrom
vliggio:docs/readme-update
Open

Update README for accuracy and completeness#422
vliggio wants to merge 1 commit into
cloudflare:mainfrom
vliggio:docs/readme-update

Conversation

@vliggio

@vliggio vliggio commented Apr 12, 2026

Copy link
Copy Markdown

Summary

  • Fix stale links (Wrangler docs, Worker secrets docs)
  • Update examples to Wrangler v3 (version number, kv key put syntax)
  • Fix typo ("continous" → "continuous") and outdated "Wrangler 2" reference
  • Reframe "Big Changes in v3" as "Migrating from v2"
  • Document missing inputs (quiet, vars) and outputs (pages-deployment-id, pages-environment)
  • Make all YAML examples runnable (add runs-on, actions/checkout step, proper list syntax)
  • Remove first-person voice ("I've set…" → "the secret name is set to…")

Test plan

  • Verify all links resolve correctly
  • Confirm documented inputs/outputs match action.yml
  • Spot-check YAML examples are valid and copy-pasteable

@vliggio
vliggio requested review from a team as code owners April 12, 2026 23:43
@vliggio
vliggio requested a review from ascorbic April 12, 2026 23:43
- Fix stale links (Wrangler docs, Worker secrets)
- Update examples to Wrangler v3 (version number, KV syntax)
- Fix typo ("continous") and "Wrangler 2" reference
- Reframe "Big Changes in v3" as "Migrating from v2"
- Document missing inputs (quiet, vars) and outputs
  (pages-deployment-id, pages-environment)
- Make all YAML examples runnable (add runs-on, checkout step)
- Remove first-person voice

Authored along with the magical Claude.ai
@vliggio
vliggio force-pushed the docs/readme-update branch from 0c44171 to 15264ab Compare May 26, 2026 20:34
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