Skip to content

Streamline setup docs and env var comments#104

Merged
stylessh merged 1 commit intomainfrom
stylessh/update-setup-docs
Apr 13, 2026
Merged

Streamline setup docs and env var comments#104
stylessh merged 1 commit intomainfrom
stylessh/update-setup-docs

Conversation

@stylessh
Copy link
Copy Markdown
Owner

Summary

  • Restructures the README getting-started guide into clear numbered steps (clone → OAuth App → GitHub App → install → env vars → migrate → run), with field-by-field instructions for each GitHub app setup
  • Moves the large permissions and webhook events reference tables into collapsible <details> sections to reduce noise
  • Adds a dedicated "Local webhook testing" section and a dashboard-specific scripts table
  • Rewrites .dev.vars.example with labeled sections and inline "how to get these" steps for every credential
  • Updates CONTRIBUTING.md with a directory tree, auth callback reference, and code style conventions

Test plan

  • Follow the README steps from scratch to verify the flow is accurate and nothing is missing
  • Confirm .dev.vars.example comments match the actual env vars used in code
  • Check that collapsible sections render correctly on GitHub

Restructure README getting-started into numbered steps with field-by-field
instructions, move reference tables into collapsible sections, and add
detailed comments to .dev.vars.example for each credential group.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
diffkit b325ca2 Apr 13 2026, 11:19 PM

@stylessh stylessh merged commit 7836806 into main Apr 13, 2026
4 checks passed
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