Skip to content

Polish README onboarding flow#82

Merged
adamziel merged 1 commit into
mainfrom
readme-onboarding-polish
May 29, 2026
Merged

Polish README onboarding flow#82
adamziel merged 1 commit into
mainfrom
readme-onboarding-polish

Conversation

@adamziel

Copy link
Copy Markdown
Contributor

What changed

Evaluated the new-user README review and applied the parts that make setup more deterministic for both humans and LLM-assisted edits:

  • Add a setup-selection table before the quickstarts.
  • Explain GITHUB_TOKEN, artifacts, kind, and expected results at the point they first appear.
  • Clarify recipe snippet placement and Blueprint input choices.
  • Move the ZIP-shape warning closer to the build-step examples.
  • Add an LLM prompt/checklist to prevent common bad workflow output.

I left the live examples near the top because they provide useful proof immediately after the quickstarts, and moving them would be a larger structural change with less direct setup impact.

Validation

  • README fence/stale-phrase sanity check
  • git diff --check README.md
  • node scripts/test-preview-workflows.mjs

@adamziel adamziel merged commit 5e92f5e into main May 29, 2026
1 check passed
@adamziel adamziel deleted the readme-onboarding-polish branch May 29, 2026 01:03
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