Skip to content

Add getting started guide for new users#421

Open
vliggio wants to merge 5 commits into
cloudflare:mainfrom
vliggio:docs/getting-started-guide
Open

Add getting started guide for new users#421
vliggio wants to merge 5 commits into
cloudflare:mainfrom
vliggio:docs/getting-started-guide

Conversation

@vliggio

@vliggio vliggio commented Apr 2, 2026

Copy link
Copy Markdown

Summary

  • Adds docs/getting-started.md with step-by-step instructions for setting up the action from scratch
  • Covers: API token creation, finding account ID, adding GitHub secrets, project setup (Workers & Pages), workflow configuration, common issues
  • Adds a link from the README to the new guide
  • Addresses review feedback: adds Zone Resources permission, clarifies dashboard navigation, fixes Pages auto-creation claims with explicit fallback
  • Adds GitHub-hosted vs self-hosted runners section with comparison table and requirements
  • Adds stubbed example projects under docs/examples/ for both Pages and Workers deployments

Closes #414

Test plan

  • Review guide for accuracy against current Cloudflare dashboard flow
  • Verify the Pages example workflow works for a new project (auto-creation and explicit creation)
  • Verify the Workers example workflow works with a fresh wrangler init project
  • Confirm Zone Resources permission is needed for token setup
  • Test example stubs can be copied into a new repo and run successfully

Comment thread docs/getting-started.md
Comment thread docs/getting-started.md
Comment thread docs/getting-started.md
Comment thread docs/getting-started.md Outdated
Comment thread docs/getting-started.md Outdated
Comment thread docs/examples/pages/.github/workflows/deploy.yml Outdated
Comment thread docs/examples/worker/.github/workflows/deploy.yml
@carlspring

Copy link
Copy Markdown

@ascorbic / @cloudflare/wrangler @cloudflare/banda-team,

Ping?

vliggio added 5 commits May 26, 2026 12:58
Addresses cloudflare#414 — step-by-step documentation for setting up the action
from scratch, covering API token creation, account ID, GitHub secrets,
project setup (Workers and Pages), and workflow configuration.

Authored along with the magical Claude.ai
Address review feedback: explain that wrangler.toml goes in the repo
root (or workingDirectory) and is found automatically, and clarify
that Pages/Workers permissions are either-or, not both required.

Authored along with the magical Claude.ai
- Add Zone Resources permission to custom token instructions
- Clarify dashboard navigation to Workers & Pages under Compute
- Fix Pages project auto-creation claims to note it may not always work
  and provide explicit creation command as fallback

Authored along with the magical Claude.ai
- Add GitHub-hosted vs self-hosted runners section to getting started guide
  with comparison table and self-hosted requirements
- Add stubbed Pages and Worker example projects under docs/examples/
- Note runner choice in example workflow comments

Authored along with the magical Claude.ai
Pages deploy auto-creates the project, so the commented block was
unnecessary. Replaced with a brief inline comment.

Authored along with the magical Claude.ai
@vliggio vliggio force-pushed the docs/getting-started-guide branch from 47c3a17 to f676c2e Compare May 26, 2026 16:58
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.

Add documentation on how to get this GitHub action to work from scratch

2 participants