Skip to content

[No QA] Update Workspace-Workflows.md - #72634

Merged
brianlee-expensify merged 3 commits into
mainfrom
clarajones-expensify-patch-3-1
Oct 17, 2025
Merged

brianlee-expensify merged 3 commits into
mainfrom
clarajones-expensify-patch-3-1

Conversation

@clarajones-expensify

Copy link
Copy Markdown
Contributor

@clarajones-expensify clarajones-expensify self-assigned this Oct 14, 2025
@clarajones-expensify
clarajones-expensify requested a review from a team as a code owner October 14, 2025 21:41
@melvin-bot

melvin-bot Bot commented Oct 14, 2025

Copy link
Copy Markdown

Concierge reviewer checklist:

  • I have verified the accuracy of the article
    • The article is within a hub that makes sense, and the navigation is correct
    • All processes, screenshots, and examples align with current product behavior.
    • All links within the doc have been verified for correct destination and functionality.
  • I have verified the readability of the article
    • The article's language is clear, concise, and free of jargon.
    • The grammar, spelling, and punctuation are correct.
    • The article contains at least one image, or that an image is not necessary
  • I have verified the formatting of the article
    • The article has consistent formatting (headings, bullet points, etc.) with other HelpDot articles and that aligns with the HelpDot formatting standards.
    • The article has proper text spacing and breaks for readability.
  • I have verified the article has the appropriate tone and style
    • The article's tone is professional, friendly, and suitable for the target audience.
    • The article's tone, terminology, and voice are consistent throughout.
  • I have verified the overall quality of the article
    • The article is not missing any information, nor does it contain redundant information.
    • The article fully addresses user needs.
  • I have verified that all requested improvements have been addressed

For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member?

cc @brianlee-expensify

@melvin-bot
melvin-bot Bot requested review from brianlee-expensify and removed request for a team October 14, 2025 21:41
@melvin-bot

melvin-bot Bot commented Oct 14, 2025

Copy link
Copy Markdown

@brianlee-expensify Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates the Workspace-Workflows.md documentation to reflect a UI terminology change from "Delay Submissions" to "Submission Frequency" and adds comprehensive FAQ content to address common user questions about submission workflows.

Scores Summary

  • Readability: 8/10 - Clear, well-structured content with good use of formatting elements
  • AI Readiness: 8/10 - Descriptive headings and proper metadata, though could benefit from more context
  • Style Compliance: 9/10 - Excellent adherence to HelpDot conventions and terminology standards

Key Findings

Positive Aspects:

  • Clean terminology update that aligns documentation with current UI labels
  • Comprehensive FAQ section addresses real user pain points and edge cases
  • Proper use of Expensify terminology (workspace, member, etc.)
  • Good hierarchical structure with clear headings
  • Effective use of bullet points and formatting for readability

Areas for Enhancement:

  • Some FAQ answers could be more specific about user actions required
  • The "Instantly" option explanation is brief compared to other frequency options
  • Cross-references to related features could be added for better discoverability

Recommendations

  1. Add context to FAQ answers: Consider expanding answers to include specific user actions or next steps where applicable
  2. Consider cross-linking: Add references to related documentation (e.g., bank account setup, approval workflows)
  3. Maintain consistency: Ensure the terminology change is reflected across all related documentation files

Files Reviewed

  • /docs/articles/new-expensify/workspaces/Workspace-Workflows.md - Approved - Well-executed terminology update with valuable FAQ additions that improve user experience

The documentation changes successfully modernize the content while maintaining high quality standards. The new FAQ section is particularly valuable for addressing common user confusion around submission frequency behaviors.

@OSBotify

OSBotify commented Oct 14, 2025 •

Copy link
Copy Markdown
Contributor

A preview of your ExpensifyHelp changes have been deployed to https://e52bfb41.helpdot.pages.dev ⚡️

Updated articles:

@brianlee-expensify

Copy link
Copy Markdown
Contributor

reviewing now!

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates the Workspace Workflows documentation to reflect UI and terminology changes, specifically renaming "Delay Submissions" to "Submission Frequency" and adding new FAQ content. The changes improve clarity around submission behavior and provide additional user guidance.

Scores Summary

  • Readability: 8/10 - Content flows well with clear explanations, though some technical details could be simplified
  • AI Readiness: 9/10 - Excellent descriptive headings, proper context, and comprehensive metadata
  • Style Compliance: 9/10 - Strong adherence to Expensify voice, proper terminology, and consistent formatting

Key Findings

Positive Aspects:

  • Terminology update from "Delay Submissions" to "Submission Frequency" better reflects the feature's purpose
  • Added "Instantly" option provides complete picture of submission frequency options
  • New FAQ section addresses common user questions comprehensively
  • Proper use of bold formatting for UI elements and workspace types
  • Maintains consistent heading hierarchy (# and ## only)

Areas for Improvement:

  • The "Instantly" option description could be more descriptive
  • Pacific Standard Time reference should clarify PST/PDT handling
  • Minor inconsistency in bullet point formatting (mix of - and •)

Recommendations

Priority Actions:

  1. Consider expanding the "Instantly" description to: "Instantly - Expenses are submitted immediately upon creation"
  2. Update timezone reference to "Pacific Time (PT)" to account for daylight saving changes
  3. Standardize bullet point formatting throughout the document

Style Suggestions:

  • The FAQ answers are well-structured and user-focused
  • Metadata keywords appropriately updated to include "submission frequency"
  • Proper use of workspace terminology (Workspace Owner, Workspace Admin)

Files Reviewed

  • docs/articles/new-expensify/workspaces/Workspace-Workflows.md - Well-executed update with improved terminology, added functionality documentation, and comprehensive FAQ additions

Impact Analysis

This update improves user understanding by:

  • Aligning documentation with current UI terminology
  • Providing complete submission frequency options
  • Addressing common user confusion through expanded FAQ
  • Maintaining AI searchability with proper metadata updates

Note: This is a high-quality documentation update that enhances user experience while maintaining strong compliance with HelpDot standards.

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates the Workspace Workflows documentation with important clarifications about submission frequency functionality. The changes improve user understanding by adding the "Instantly" option, renaming "Delay Submissions" to "Submission Frequency," and expanding the FAQ section with four new practical questions that address common user scenarios.

Scores Summary

  • Readability: 8/10 - Clear, well-structured content with good use of formatting. Writing is accessible and follows a logical flow.
  • AI Readiness: 9/10 - Excellent descriptive headings, proper YAML metadata updated with relevant keywords, and consistent markdown structure.
  • Style Compliance: 9/10 - Strong adherence to Expensify voice and terminology standards, proper use of bold formatting for UI elements, and consistent FAQ structure.

Key Findings

  • Positive aspects worth highlighting:

    • Clear terminology improvement: "Delay Submissions" → "Submission Frequency" better reflects actual functionality
    • Addition of "Instantly" option fills a significant gap in documentation
    • New FAQ sections address practical user scenarios with specific, actionable answers
    • Proper use of bold formatting for UI elements and technical terms
    • Keywords metadata appropriately updated to include "submission frequency"
  • Strong technical accuracy:

    • Accurate timing specifications (evening PST for automated submissions)
    • Clear explanation of Individual workspace inheritance behavior
    • Proper acknowledgment of current product limitations
  • Minor considerations:

    • All changes align well with existing documentation patterns
    • FAQ structure follows established guidelines
    • Cross-references to relevant sections maintained

Recommendations

  • Continue the excellent work - This update significantly improves the documentation quality
  • Consider adding visual indicators or examples for the "Instantly" vs other frequency options to further enhance user understanding
  • Monitor user feedback on the new FAQ sections to identify any additional common questions that might emerge

Files Reviewed

  • docs/articles/new-expensify/workspaces/Workspace-Workflows.md: ✅ Excellent - Well-structured improvements that enhance clarity, add missing information, and provide valuable FAQ content. Changes demonstrate strong understanding of user needs and documentation best practices.

Note: This review covers all substantive changes. The improvements significantly enhance the user experience and documentation quality.

@brianlee-expensify

Copy link
Copy Markdown
Contributor

@clarajones-expensify just added two comments for revision/clarification - you can see them a lot more easily on the "Files changed" tab instead of the "Conversation" tab - let me know if you have any questions regarding my comments!

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review - Comprehensive Summary

Overall Assessment

This PR successfully modernizes the Workspace Workflows documentation by updating terminology from "Delay Submissions" to "Submission Frequency" and significantly expanding the FAQ section. The changes reflect current UI language and address common user confusion points with clear, actionable guidance.

Quality Scores Summary

  • Content Accuracy & Clarity: 9/10 - Excellent technical accuracy with clear explanations
  • Grammar & Style: 9/10 - Well-written, professional tone consistent with HelpDot standards
  • Formatting & Structure: 9/10 - Proper markdown structure, consistent headings, effective use of formatting
  • Completeness: 8/10 - Comprehensive coverage with room for minor enhancements
  • User Experience: 9/10 - User-focused content that addresses real pain points
  • Consistency: 9/10 - Maintains consistency with existing documentation patterns

Key Strengths

✅ Terminology Alignment: The shift from "Delay Submissions" to "Submission Frequency" better reflects the feature's actual functionality and aligns with current UI labels

✅ Complete Feature Coverage: Addition of the "Instantly" submission option fills a significant documentation gap

✅ Comprehensive FAQ: Four new FAQ items address practical scenarios:

  • Default behavior when no frequency is set
  • Individual workspace inheritance from Expensify Classic
  • Timing specifications for automated submissions
  • Current limitations around credit card report separation

✅ Technical Precision: Accurate details about PST timing, violation handling, and workflow interactions

✅ Proper Formatting: Consistent use of bold formatting for UI elements, proper heading hierarchy, and effective bullet point structure

Areas for Enhancement

⚠️ Minor Terminology Refinement: Consider updating "Pacific Standard Time (PST)" to "Pacific Time (PT)" to account for daylight saving time changes

⚠️ Enhanced Context: The "Instantly" option description could be slightly expanded for clarity

Impact Analysis

This update significantly improves the user experience by:

  • Reducing Confusion: Clear terminology that matches the UI
  • Providing Complete Information: All submission frequency options now documented
  • Addressing Common Issues: FAQ section tackles frequently asked questions
  • Maintaining Discoverability: Updated keywords metadata supports AI/search functionality

Recommendation: APPROVE

This is a high-quality documentation update that enhances clarity, completeness, and user experience while maintaining excellent compliance with HelpDot standards. The changes demonstrate strong understanding of user needs and documentation best practices.

Priority: Low Risk

All changes improve existing content without introducing breaking changes or removing essential information. The updates are additive and clarifying in nature.

Review completed on latest commit 38df4c6

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates the Workspace-Workflows.md documentation to address UI terminology changes and expand user guidance around submission workflows. The changes reflect a rename from "Delay Submissions" to "Submission Frequency" and add comprehensive FAQ content to address common user questions and edge cases.

Scores Summary

  • Readability: 8/10 - Clear, well-structured content with good use of formatting elements and logical flow. Technical explanations are accessible without being oversimplified.
  • AI Readiness: 9/10 - Excellent descriptive headings, proper YAML metadata structure, and consistent hierarchy. Keywords appropriately updated to include "submission frequency".
  • Style Compliance: 9/10 - Strong adherence to Expensify voice and tone standards, proper use of workspace terminology, and consistent markdown formatting.

Key Findings

Major Improvements:

  • Terminology alignment: The rename from "Delay Submissions" to "Submission Frequency" better reflects the feature's actual functionality and aligns with current UI labels
  • Complete feature coverage: Addition of the "Instantly" submission option fills a significant documentation gap
  • Enhanced user support: Four new FAQ entries address practical scenarios that users commonly encounter
  • Technical accuracy: Precise timing specifications and clear explanation of inheritance behaviors from Individual workspaces

Documentation Quality Strengths:

  • Proper use of bold formatting for UI elements (Workspace Admin, Workspace Owner)
  • Consistent bullet point structure for submission frequency options
  • Clear hierarchical organization with appropriate heading levels
  • Maintained cross-references to related documentation (bank account setup guide)

Areas Successfully Addressed:

  • Complete submission frequency option list now includes all available choices
  • FAQ section addresses edge cases like Individual workspace inheritance
  • Technical details appropriately balanced for target audience
  • Metadata properly updated to support AI discoverability

Recommendations

Excellent execution overall - This update demonstrates strong understanding of user needs and documentation best practices. The changes significantly improve the user experience by:

  • Aligning documentation with current product terminology
  • Providing complete information about all submission options
  • Anticipating and addressing common user confusion points
  • Maintaining consistency with established HelpDot standards

Minor enhancements to consider:

  • The FAQ answers provide specific, actionable guidance
  • Cross-references to related features enhance discoverability
  • Technical accuracy maintained throughout all changes

Files Reviewed

  • docs/articles/new-expensify/workspaces/Workspace-Workflows.md: ✅ Approved - High-quality update that modernizes terminology, adds missing functionality documentation, and provides valuable FAQ content that will reduce user confusion and support inquiries.

Overall Recommendation

APPROVE - This is a well-executed documentation improvement that enhances clarity, completeness, and user experience while maintaining strong compliance with HelpDot standards. The changes address real user needs and improve the overall quality of the workspace workflows documentation.

Final Score: 26/30 (87%) - High quality documentation update recommended for approval.

@brianlee-expensify

Copy link
Copy Markdown
Contributor

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

@brianlee-expensify
brianlee-expensify merged commit 4031661 into main Oct 17, 2025
2 checks passed
@brianlee-expensify
brianlee-expensify deleted the clarajones-expensify-patch-3-1 branch October 17, 2025 18:21
@melvin-bot melvin-bot Bot added the Emergency label Oct 17, 2025
@melvin-bot

melvin-bot Bot commented Oct 17, 2025

Copy link
Copy Markdown

@brianlee-expensify looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@clarajones-expensify

Copy link
Copy Markdown
Contributor Author

Checklist is right here: #72634 (comment)

@OSBotify OSBotify mentioned this pull request Oct 20, 2025
44 tasks done
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/brianlee-expensify in version: 9.2.34-0 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.2.34-2 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

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.

3 participants