Skip to content

[No QA] [NoQA] Align ONL583 help docs with name-conflict errors - #102822

Open
francoisl wants to merge 3 commits into
mainfrom
francois-help-doc-qboONL583
Open

[No QA] [NoQA] Align ONL583 help docs with name-conflict errors#102822
francoisl wants to merge 3 commits into
mainfrom
francois-help-doc-qboONL583

Conversation

@francoisl

@francoisl francoisl commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Update the New Expensify and Classic articles to match the revised ONL583 error. Explain customer and employee name conflicts and the rename-or-create fixes so admins can resolve blocked exports.

Fixed Issues

N/A
Follow up of https://github.com/Expensify/Integration-Server/pull/9461

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

N/A

  • Verify that no errors appear in the JS console

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 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 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • 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)
  • 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(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@francoisl
docs(qbo): align ONL583 help with name-conflict errors
516c9b1 
Update the New Expensify and Classic articles to match the revised
ONL583 error. Explain customer and employee name conflicts and the
rename-or-create fixes so admins can resolve blocked exports.
@francoisl
docs(qbo): restore original ONL583 article titles
f5fd0e0 
Keep the page headings and title metadata consistent with the
existing format used by other export-error help articles.
@francoisl
francoisl marked this pull request as ready for review October 1, 2026 23:39
@github-actions github-actions Bot changed the title [NoQA] Align ONL583 help docs with name-conflict errors [No QA] [NoQA] Align ONL583 help docs with name-conflict errors Oct 1, 2026
@OSBotify

This comment has been minimized.

Sign in to view
@OSBotify

This comment has been minimized.

Sign in to view
@github-actions

github-actions Bot commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR revises the two ONL583 export error articles (New Expensify and Expensify Classic) to align with the updated error message, reframing the problem from a generic vendor-matching issue to a specific name-conflict between a vendor/supplier and another record (customer/employee) or a different email. The rewrites are a clear improvement: they lead with a concrete example of the error, explain the root cause accurately, and consolidate several overlapping fix sections into one focused resolution workflow plus updated FAQs.

Scores Summary

  • Readability: 9/10 - Tight, scannable prose. The blockquoted error example and the single numbered fix sequence are much easier to follow than the previous multi-section approach. Minor wordiness in a couple of FAQ answers.
  • AI Readiness: 9/10 - Strong metadata on both files: full feature names in title/keywords, and a well-formed internalScope with audience, coverage, and explicit exclusions. Task-based "How to Fix the Name Conflict in QuickBooks Online" heading, single title heading, only top-two heading levels, question-word FAQ headings.
  • Style Compliance: 7/10 - Terminology (Workspace Admin, report submitter) is consistent. Main gap: the recurring instruction "Sync the QuickBooks Online connection in Expensify" is not tied to an exact UI control (the prior version used Sync now), which conflicts with the Core UI Referencing and Deterministic Writing rules.

Key Findings

  • Positive: Accurate reframing to a name-conflict error, with a verbatim error example that matches real user search intent and improves retrieval.
  • Positive: Metadata (internalScope, keywords, description) updated on both files and strongly aligned with search intent and governance.
  • Positive: Removing the Web/Mobile "Disable Automatically create employees/vendors" steps is justified - the real fix lives in QuickBooks Online, and this is now handled cleanly in an FAQ instead.
  • To address: The sync step should name the exact Expensify control (e.g., Sync now) rather than the generic "sync the connection," per HELPSITE_NAMING_CONVENTIONS.md (exact UI labels, no generalizing, no vague navigation phrases).
  • Minor: Headings use Title Case ("How to Fix the Name Conflict") rather than sentence case. This matches the pre-existing article and is not introduced by the diff, so it is noted only for consistency.

Recommendations

  • Replace "Sync the QuickBooks Online connection in Expensify" / "sync the connection in Expensify" with the exact UI action (bolded, e.g. Click Sync now) in both files' fix step and FAQ answers.
  • Optionally add a brief pointer to where the sync control lives so the instruction is deterministic across Web and Mobile.

Files Reviewed

  • docs/articles/new-expensify/connections/quickbooks-online/Troubleshooting/Export-Errors/ONL583-Export-Error.md - Improved; address the vague sync reference.
  • docs/articles/expensify-classic/connections/quickbooks-online/Troubleshooting/Export-Errors/ONL583-Export-Error.md - Improved; same vague sync reference to fix.

Note: Detailed line-by-line feedback has been provided as inline comments.

@francoisl
docs(qbo): use exact sync labels in ONL583 help
a6eb29e 
Match each platform's sync control so admins can follow the
troubleshooting steps without guessing. Apply the exact labels to
both the export steps and related FAQs.
@francoisl

francoisl commented Oct 1, 2026

Copy link
Copy Markdown
Contributor Author

(Francois' agent)

Addressed all three sync-label comments in a6eb29e. Both articles now use the exact UI labels: Sync now for New Expensify and Sync Now for Classic. I updated the related FAQ references and clarified that the export should be retried after the sync completes.

Spelling and whitespace checks pass.

@OSBotify

OSBotify commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

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

Updated articles:

This branch has not been deployed

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

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments
@stephanieelliott stephanieelliott Awaiting requested review from stephanieelliott stephanieelliott is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@francoisl francoisl

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@francoisl @OSBotify