Skip to content

update: Workflow about and quickstart page update - #774

Open
tamalchowdhury wants to merge 3 commits into
mainfrom
tamal/update/workflow-section-overhaul
Open

update: Workflow about and quickstart page update#774
tamalchowdhury wants to merge 3 commits into
mainfrom
tamal/update/workflow-section-overhaul

Conversation

@tamalchowdhury

@tamalchowdhury tamalchowdhury commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

This PR starts an overhaul of the Workflow section. Update in progress.

Summary by CodeRabbit

  • Documentation
    • Reorganized and refreshed the “About Kinde workflows” guide with clearer sections, updated navigation, and revised examples.
    • Added a TypeScript workflow example covering permissions and feature flags.
    • Clarified workflow triggers, rules, limitations, related resources, and next steps.
    • Expanded the quick-start guide with numbered template setup instructions and a complete manual setup path.
    • Added guidance for repository connection, configuration, workflow creation, testing, runtime logs, tutorials, and examples.

@tamalchowdhury
tamalchowdhury requested a review from a team as a code owner July 28, 2026 12:25
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The workflows overview and quickstart pages were restructured with updated metadata, a TypeScript example, consolidated workflow guidance, expanded setup instructions, testing steps, and refreshed navigation links.

Changes

Workflow documentation

Layer / File(s) Summary
Overview metadata and usage guidance
src/content/docs/workflows/about-workflows/index.mdx
Page metadata, introductory explanation, workflow steps, and usage guidance were updated.
Example workflow
src/content/docs/workflows/about-workflows/index.mdx
A TypeScript example demonstrates clearing permissions and feature flags through access token custom claims.
Triggers, rules, limitations, and navigation
src/content/docs/workflows/about-workflows/index.mdx
Trigger references, workflow rules, limitations, GitHub links, and next-step links were reorganized and rewritten.
Template and manual quickstart flows
src/content/docs/workflows/getting-started/quick-start-guide.mdx
The guide now covers template prerequisites, manual project creation, configuration, repository connection, testing, and workflow navigation.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

Poem

A rabbit reads each workflow guide,
With clear setup steps aligned.
Triggers, claims, and rules appear,
Manual paths are now clear,
Fresh links mark the route ahead.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the two updated Workflow pages and matches the main changes in the pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch tamal/update/workflow-section-overhaul

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/workflows/getting-started/quick-start-guide.mdx`:
- Around line 198-204: Update the commit-and-push instructions in the
quick-start guide to configure the GitHub remote and upstream branch before
running git push. Include the required remote setup using the reader’s
repository URL, then preserve the existing commit flow so the repository can be
connected in step 4.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 05a70b17-0702-49c0-8ad9-a60727b05a7d

📥 Commits

Reviewing files that changed from the base of the PR and between d1d2876 and c65a13f.

📒 Files selected for processing (1)
  • src/content/docs/workflows/getting-started/quick-start-guide.mdx

Comment thread src/content/docs/workflows/getting-started/quick-start-guide.mdx
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploying kinde-docs-preview with  Cloudflare Pages  Cloudflare Pages

Latest commit: a8f03fe
Status: ✅  Deploy successful!
Preview URL: https://99a003b0.kinde-docs-preview.pages.dev
Branch Preview URL: https://tamal-update-workflow-sectio.kinde-docs-preview.pages.dev

View logs

@tamalchowdhury tamalchowdhury changed the title (Work in progress) update: Workflow section overhaul update: Workflow section overhaul Aug 11, 2026
@tamalchowdhury tamalchowdhury changed the title update: Workflow section overhaul update: Workflow about and quickstart page update Aug 11, 2026

@dtoxvanilla1991 dtoxvanilla1991 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice overhaul of the workflows landing page and quickstart - the manual "build it yourself" path is a good addition alongside the template path, and the sample code is traceable straight back to the existing token-customization tutorial rather than being invented fresh. Note: 📓
about-workflows/index.mdx's meta description only mentions "your own TypeScript," but the page itself (and languages: [typescript, javascript]) says workflows can be plain JS too. Worth a word tweak next time this page gets touched, not worth holding this PR for.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants