docs: standardize workflows-overview structure and add missing components#1677
Merged
serikjensen merged 2 commits intomainfrom May 7, 2026
Merged
docs: standardize workflows-overview structure and add missing components#1677serikjensen merged 2 commits intomainfrom
serikjensen merged 2 commits intomainfrom
Conversation
…ents Aligns all workflow docs with the company-onboarding template (Available Subcomponents up top, anchor-linked, consistent Props/Events tables). Adds previously undocumented components and a dedicated Information Requests workflow doc. Also exports StateTaxesForm and StateTaxesList under the CompanyOnboarding namespace so docs can drop the legacy-only note (Company.* legacy paths still work). Co-authored-by: Cursor <cursoragent@cursor.com>
serikjensen
requested review from
dmortal,
hukid,
jeffredodd and
krisxcrash
as code owners
No issues foundGenerated by Fresh Eyes Reviewer | Share feedback in #ai-code-reviews |
Contributor
There was a problem hiding this comment.
This is so much more clear now! Is there any way we can also mention the recommended subcomponents for other events? Things like the employee details, compensation, etc. Or just make it very clear when there isn't a standalone component you can just use
Member
Author
There was a problem hiding this comment.
👋 is this feedback specific to employee dashboard? if so, this should get fleshed out more completely as we round out the remainder of the steady state components and get them documented!
jeffredodd
approved these changes
May 7, 2026
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
3 participants
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
Standardizes every doc under
docs/workflows-overview/against thecompany-onboarding.mdtemplate so partners can scan them the same way:### Available Subcomponentslist whose links jump to per-component sections with consistent Props / Events tables.src/index.tsagainst existing docs and filled in:CompanyOnboarding.Industry,CompanyOnboarding.OnboardingOverview,CompanyOnboarding.DocumentList,CompanyOnboarding.SignatureFormEmployeeOnboarding.EmploymentEligibilityEmployeeManagement.EmployeeList,EmployeeManagement.WorkAddressPayroll.PayrollExecutionFlow,Payroll.RecoveryCases, and correctedPayroll.PayrollBlocker→Payroll.PayrollBlockerListinformation-requests.mdworkflow doc coveringInformationRequests.InformationRequestsFlow,InformationRequestList, andInformationRequestForm(previously listed in the overview index with no dedicated page).off-cycle-payroll.md,transition-payroll.md, anddismissal-payroll.mdnow link toPayroll.PayrollExecutionFlowinrun-payroll.mdinstead of duplicating it.employee-dashboard.mdevent tables and the example handler now usecomponentEvents.*constants (e.g.EMPLOYEE_HOME_ADDRESS) instead of the lowercase string literals it had drifted to.StateTaxesForm/StateTaxesListtosrc/components/Company/exports/companyOnboarding.tsso they're available underCompanyOnboarding.*like every other subcomponent. ExistingCompany.StateTaxesForm/Company.StateTaxesListconsumers are unaffected (the legacyCompany.*namespace still re-exports the same components), so the docs no longer need the "(legacyCompany.*only)" annotation.No runtime behavior changes outside the additive
CompanyOnboardingre-exports.Test plan
npm run buildsucceeds (lint-staged ran the build during commit; verify in CI).import { CompanyOnboarding } from '@gusto/embedded-react-sdk'exposesCompanyOnboarding.StateTaxesFormandCompanyOnboarding.StateTaxesList, and thatCompany.StateTaxesForm/Company.StateTaxesListstill resolve to the same components.Made with Cursor