Skip to content

Docs updates for E/A#101522 Reconciliation export for card group selections - #101993

Closed
MelvinBot wants to merge 1 commit into
mainfrom
claude-docsReconciliationExportCardGroups
Closed

MelvinBot wants to merge 1 commit into
mainfrom
claude-docsReconciliationExportCardGroups

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Help site follow-up to Extend Reconciliation - All Expenses export to any group-by:card selection (Expensify/App#101522).

That PR carved out an exception to the rule that export templates are hidden for group selections: on a search grouped by Card, selecting a card group row now keeps Reconciliation - All Expenses in the Export menu alongside Current view, scoped to every expense on the selected card groups. Every other grouping is unchanged.

No help article described this. The help site was inaccurate in two ways:

  • Search-and-Download-Expenses.md documented group exports as Current view only, which is no longer true for card groups.
  • Reconciliation - All Expenses was not listed as an export template anywhere on the help site, even though it predates this PR.

Changes:

  • docs/articles/new-expensify/reports-and-expenses/Statement-Matching-and-Reconciliation.md — added ## How to Export the Card Transactions You Are Reconciling with the four-step flow from the Card statements view, a note that the export covers unscrolled transactions and individually checked ones, and an FAQ covering why the template is hidden for members who aren't a Workspace Admin or card admin. Added export terms to keywords and internalScope.
  • docs/articles/new-expensify/reports-and-expenses/Search-and-Download-Expenses.md — extended the Export grouped expenses section with the Card exception and an explicit statement that every other grouping still offers Current view only. Added the FAQ ## Why don't I see export templates when I select a group?.
  • docs/articles/new-expensify/reports-and-expenses/How-to-Export-Expenses.md — added Reconciliation - All Expenses to the template list and its availability rule to the Why don't I see certain export templates? FAQ.
UI labels verified against source

Every label was checked against the code rather than the rendered app, since NewDot web could not be driven in a browser for this run:

Both Accounting shortcuts named in the articles really are groupBy:card searches, so the exception applies to them: SearchSuggestionUtils.ts:292 (Card statements) and SearchSuggestionUtils.ts:340 (Card accruals).

The "Workspace Admin or card admin of a card-enabled workspace" gate on the template comes from isAdminOfCardEnabledPolicy in src/libs/actions/Search.ts:2084 and src/hooks/useSearchBulkActions.ts:752.

Authoring guideline compliance

Checked against docs/HELPSITE_NAMING_CONVENTIONS.md, docs/HELP_AUTHORING_GUIDELINES.md, and docs/TEMPLATE.md:

  • All new headings are task-based and start with an action verb or question word; no new # headings were introduced, only ##.
  • All UI labels are bolded, unquoted, and match the strings above exactly.
  • Navigation uses the unified "In the navigation tabs (on the left on web, on the bottom on mobile)" phrasing already established in these articles.
  • Cross-links are relative and placed in explanatory sentences, not inside numbered steps.
  • Each article's existing heading case was preserved (Statement-Matching-and-Reconciliation.md uses Title Case throughout; the other two use sentence case), so the edits don't introduce inconsistency within a file.

Not changed, flagged for a separate pass: How-to-Export-Expenses.md refers to the menu item as Export current view in three places, but the actual label is Current view. That predates this PR and fixing it is out of scope here.

Fixed Issues

$ #99172
PROPOSAL:

Tests

// TODO: The human co-author must fill out the tests you ran before marking this PR as "ready for review"
// Please describe what tests you performed that validates your changed worked.

Suggested check for the reviewer — this is a docs-only change, so it needs a read-through rather than a build:

  1. Read the rendered diff on all three articles and confirm the described behavior matches what you see in the product.
  2. On a workspace with card transactions, open the Card statements shortcut, check a card group row, and confirm the Export menu lists exactly Current view and Reconciliation - All Expenses — matching what the articles now say.
  3. Group the Expenses search by Category, check a group row, and confirm Current view is the only option — matching the "every other grouping" statement.
  • Verify that no errors appear in the JS console

Offline tests

N/A — documentation only, no app code changes.

QA Steps

// TODO: The human co-author must fill out the QA tests you ran before marking this PR as "ready for review".
// Please describe what QA needs to do to validate your changes and what areas do they need to test for regressions.

  • 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.
  • 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

@ZhenjaHorbach, please review the files changed and confirm they reflect the current behavior. Then post a new comment saying @MelvinBot mark this PR as ready for review.

…lections

Co-authored-by: Yauheni Horbach <ZhenjaHorbach@users.noreply.github.com>
@stephanieelliott

Copy link
Copy Markdown
Contributor

No update needed on this, per tightened Melvinbot criteria (see https://github.com/Expensify/Expensify/issues/685679). Please comment or reopen if you disagree!

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

Labels

HelpDot Apply this label if the issue relates to ExpensifyHelp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants