docs: add workflow overviews for off-cycle, dismissal, and transition payrolls#1338
Merged
jeffredodd merged 5 commits intomainfrom Mar 30, 2026
Merged
docs: add workflow overviews for off-cycle, dismissal, and transition payrolls#1338jeffredodd merged 5 commits intomainfrom
jeffredodd merged 5 commits intomainfrom
Conversation
jeffredodd
force-pushed
the
docs/off-cycle-payroll-workflow
branch
from
6ec53e3 to
0f61ef7
Compare
jeffredodd
requested review from
dmortal,
hukid,
krisxcrash and
serikjensen
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Adds workflow overview documentation for additional payroll workflows (off-cycle, dismissal, transition) and updates the docs entry points so integrators can discover and implement these flows using the current SDK namespace patterns.
Changes:
- Added new workflow overview docs for
Payroll.OffCycleFlow,Payroll.DismissalFlow, andPayroll.TransitionFlow(including key props/events and integration notes). - Updated the workflows overview page to list the new workflows and to use the
Employee.*namespace pattern in the onboarding example. - Updated
README.mdto link to the new workflow docs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/workflows-overview/workflows-overview.md | Adds the new workflows to the overview list and updates the onboarding example import/usage to the current namespace pattern. |
| docs/workflows-overview/off-cycle-payroll.md | New workflow doc describing off-cycle payroll flow + subcomponents, props, and events. |
| docs/workflows-overview/dismissal-payroll.md | New workflow doc describing dismissal payroll flow, termination integration, props, and events. |
| docs/workflows-overview/transition-payroll.md | New workflow doc describing transition payroll flow, alert behavior/events, and usage patterns. |
| README.md | Adds links to the new workflow documentation pages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jeffredodd
added a commit
that referenced
this pull request
Mar 30, 2026
Addresses Copilot review feedback on PR #1338: the integration example guards on data.payScheduleUuid because TransitionFlow requires it as a non-optional prop, but the event type allows undefined. Added a note explaining this and suggesting partners add fallback logic if needed. Made-with: Cursor
krisxcrash
approved these changes
Mar 30, 2026
… payrolls Made-with: Cursor
Ran 10-pass automated fact-checking pipeline against the codebase to verify all claims in the off-cycle, dismissal, transition, and workflows-overview docs. Key corrections: - Fix EmployeeOnboardingFlow import to use Employee.OnboardingFlow namespace - Add missing payrollType prop to OffCycleFlow docs - Clarify TransitionPayrollAlert is internal to PayrollLanding, not a public export - Scope OFF_CYCLE_SELECT_REASON/DEDUCTIONS_CHANGE events to standalone subcomponents - Fix dismissal integration example to pass payrollId from event data - Correct event data types (payScheduleUuid can be undefined) - Soften transition blocking claim to reflect SDK vs API enforcement - Match UI label references to actual i18n strings - Add Information Requests to workflows list - Normalize code style (semicolons, formatting) Made-with: Cursor
Verified all three payroll workflow docs (off-cycle, dismissal, transition) through 10 systematic passes against source code. - Reorder off-cycle form fields and workflow steps to match UI render order (dates first, then reason) - Use API wire value "Dismissed employee" instead of TypeScript enum name in dismissal doc prose - Clarify transition pay schedule field is conditionally shown - Specify transition tax withholding default frequency (every-other-week) Made-with: Cursor
Addresses Copilot review feedback on PR #1338: the integration example guards on data.payScheduleUuid because TransitionFlow requires it as a non-optional prop, but the event type allows undefined. Added a note explaining this and suggesting partners add fallback logic if needed. Made-with: Cursor
jeffredodd
force-pushed
the
docs/off-cycle-payroll-workflow
branch
from
23fbb6d to
476d8f9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
New docs
docs/workflows-overview/off-cycle-payroll.md-- OffCycleFlow, subcomponents, props, events, form fieldsdocs/workflows-overview/dismissal-payroll.md-- DismissalFlow, integration with termination, pay period selectiondocs/workflows-overview/transition-payroll.md-- TransitionFlow, TransitionCreation, alert behavior, skip flowFact-check corrections applied
EmployeeOnboardingFlowimport to useEmployee.OnboardingFlownamespace patternpayrollTypeprop to OffCycleFlow documentationOFF_CYCLE_SELECT_REASON/OFF_CYCLE_DEDUCTIONS_CHANGEevents to standalone subcomponents onlypayrollIdfrom event datapayScheduleUuidcan beundefined)Test plan
Made with Cursor