Skip to content

[No QA] docs: add crop receipt documentation to help site#85497

Merged
muttmuure merged 2 commits intomainfrom
melvin-helpsite-crop-receipt
Mar 24, 2026
Merged

[No QA] docs: add crop receipt documentation to help site#85497
muttmuure merged 2 commits intomainfrom
melvin-helpsite-crop-receipt

Conversation

@MelvinBot
Copy link
Contributor

Summary

  • Adds documentation for the new Crop receipt feature (added in feat: add crop receipt #81380) to the help site article Attach-and-edit-receipts-on-expenses.md
  • Updates the Replace receipt instructions to reflect the new button-based UI (no longer in the three dots menu)
  • Adds an FAQ about cropping/rotating eReceipts
  • Adds crop receipt and rotate receipt to article keywords

Changes

  • docs/articles/new-expensify/reports-and-expenses/Attach-and-edit-receipts-on-expenses.md: Updated replace flow, added crop section, added FAQ, updated keywords

Test plan

  • Verify the article renders correctly on the help site
  • Verify the crop instructions match the current UI behavior after feat: add crop receipt #81380 merged
  • Verify the replace instructions match the new button-based UI

Update the receipt editing article to document the new crop receipt
feature added in PR #81380 and update the replace receipt instructions
to reflect the new button-based UI.

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@github-actions
Copy link
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds crop-receipt documentation to the existing "Attach and edit receipts on expenses" article. The changes include a new "How to crop a receipt image" section, a new FAQ entry about eReceipt limitations, updated keywords, and a simplified "How to replace an existing receipt" section that consolidates the previously separate web/mobile instructions into unified steps. The additions are well-structured and mostly aligned with governance standards, with a few items worth addressing.

Scores Summary

  • Readability: 8/10 - The new crop section is clear and scannable with concise numbered steps. The replace section simplification reduces duplication. The FAQ answer is direct. Minor wording nitpick: "click on" could be tightened to "click" in both the crop and replace steps for consistency with the deterministic writing rule.
  • AI Readiness: 9/10 - The new heading "How to crop a receipt image" is task-based and includes the feature name. Keywords were properly extended with "crop receipt" and "rotate receipt." The FAQ heading "Can I crop or rotate an eReceipt?" is searchable and specific. Heading hierarchy uses only ## as expected.
  • Style Compliance: 7/10 - Button names (Replace, Crop, Save, Rotate) are correctly bolded and appear to match UI casing. However, the rewrite of the "replace" section raises two governance concerns detailed below.

Key Findings

Positive aspects:

  • The new "How to crop a receipt image" section follows governance structure well: task-based heading, introductory sentence, sequential numbered steps, and a closing explanation.
  • Keywords updated to reflect the new content -- good for search and AI retrieval.
  • The new FAQ entry clearly explains the eReceipt limitation for crop/rotate, which preempts a common user question.
  • Button references are consistently bolded without quotation marks, matching the Button Naming Standards.

Items that need attention:

  1. Three dots menu removal in the replace section -- The old version instructed users to access Replace through the three dots menu ("Click the three dots > Replace"). The new version skips straight to "Click Replace" (step 2). If the UI still requires opening the three dots menu to access the Replace option, then the new instructions omit a required navigation step. If the three dots menu reference was incorrect before (i.e., Replace is directly accessible without it), then the simplification is correct. This should be verified against the current UI. If the three dots menu is still needed, the reference must follow the governance format: "Select the three dots (⋮) > Replace."

  2. Platform consolidation in the replace section -- The old version provided separate "On web" and "On mobile" instructions. The new version uses unified steps. Per HELPSITE_NAMING_CONVENTIONS.md, unified instructions are appropriate only when web and mobile navigation are structurally the same. If the flows genuinely match across platforms now, this is a valid improvement. If they differ (e.g., mobile uses a tap gesture or has a different menu), separate instructions should be retained per governance.

  3. "click on" phrasing -- Both the replace and crop sections use "click on the receipt image." Per the Deterministic Writing Rule ("Be literal. Be exact."), "click" alone is the standard phrasing (e.g., "click the receipt image"). This is a minor style consistency point.

Recommendations

  1. Verify the three dots menu flow: Confirm whether the Replace and Crop options are directly visible on the receipt image view or require opening the three dots menu first. Update the steps accordingly, using the mandated format if the menu is required.
  2. Confirm cross-platform parity for replace: Ensure the replace flow is identical on web and mobile before keeping the unified instructions. If they differ, restore separate platform sections.
  3. Tighten "click on" to "click": In steps that say "click on the receipt image," change to "click the receipt image" for precision.

Files Reviewed

  • docs/articles/new-expensify/reports-and-expenses/Attach-and-edit-receipts-on-expenses.md -- New crop section added, replace section simplified, keywords expanded, new FAQ entry for eReceipt crop/rotate limitation. Generally well-written with the governance concerns noted above.

Note: This review covers only the proposed changes in the diff, not unchanged portions of the file.

@stephanieelliott
Copy link
Contributor

@MelvinBot why didn't this PR have [NO QA] prepended to the title?

@MelvinBot
Copy link
Contributor Author

Good catch — this was an oversight on my part. Since this PR only modifies help site documentation (docs/articles/...), it doesn't require QA testing on the staging environment and should have had [No QA] prepended to the title.

I'll update the title now.

@MelvinBot MelvinBot changed the title docs: add crop receipt documentation to help site [No QA] docs: add crop receipt documentation to help site Mar 17, 2026
@OSBotify
Copy link
Contributor

OSBotify commented Mar 17, 2026

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

Updated articles:

@stephanieelliott stephanieelliott self-requested a review as a code owner March 18, 2026 00:15
@stephanieelliott stephanieelliott requested review from a team and removed request for stephanieelliott March 18, 2026 00:17
@melvin-bot
Copy link

melvin-bot bot commented Mar 18, 2026

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 @muttmuure

@melvin-bot melvin-bot bot requested a review from muttmuure March 18, 2026 00:17
@melvin-bot
Copy link

melvin-bot bot commented Mar 18, 2026

@muttmuure 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]

@melvin-bot melvin-bot bot removed the request for review from a team March 18, 2026 00:17
@muttmuure
Copy link
Contributor

muttmuure commented Mar 24, 2026

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (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 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
    • 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 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)
    • 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 verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • 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.ts or at the top of the file that uses the constant) are defined as such
  • 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
    • 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(theme.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 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 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

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

@muttmuure muttmuure merged commit 74f5e96 into main Mar 24, 2026
16 checks passed
@muttmuure muttmuure deleted the melvin-helpsite-crop-receipt branch March 24, 2026 16:05
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/muttmuure in version: 9.3.44-0 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/muttmuure in version: 9.3.47-0 🚀

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

Bundle Size Analysis (Sentry):

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.

4 participants