Skip to content

[No QA] Update Add-an-expense.md#75112

Merged
sakluger merged 2 commits intomainfrom
kadiealexander-patch-4
Nov 19, 2025
Merged

[No QA] Update Add-an-expense.md#75112
sakluger merged 2 commits intomainfrom
kadiealexander-patch-4

Conversation

@kadiealexander
Copy link
Contributor

Add descriptions for GPS tracking as per #74993

Explanation of Change

Add explanation of GPS mileage tracking.

Fixed Issues

$ #74993
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

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

Screenshots/Videos

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

Add descriptions for GPS tracking as per #74993
@kadiealexander kadiealexander requested a review from a team as a code owner November 14, 2025 03:43
@melvin-bot
Copy link

melvin-bot bot commented Nov 14, 2025

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

@melvin-bot melvin-bot bot requested a review from sakluger November 14, 2025 03:43
@melvin-bot
Copy link

melvin-bot bot commented Nov 14, 2025

@sakluger 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 November 14, 2025 03:43
@github-actions
Copy link
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates the GPS mileage tracking documentation to reflect that the feature is now available on mobile. The changes are focused and accurate, updating both the step-by-step instructions and the feature availability table. The documentation maintains consistency with the existing content style and structure.

Scores Summary

  • Readability: 8/10 - Clear and concise instructions with good action-oriented language. Minor improvement possible in feature description detail.
  • AI Readiness: 7/10 - Good contextual placement within existing structure. Could benefit from slightly more descriptive language about GPS behavior and requirements.
  • Style Compliance: 9/10 - Excellent adherence to Expensify documentation standards with proper formatting, terminology, and structure.

Key Findings

Strengths:

  • Updates both the procedural steps (line 75) and the feature comparison table (line 84) for consistency
  • Maintains the existing documentation structure and formatting conventions
  • Uses clear, action-oriented language ("Click Start", "Click Stop")
  • Includes practical guidance ("For best results, keep the Expensify app open")
  • Properly removes outdated "currently unavailable" messaging

Areas for Improvement:

  • Line 75: The instruction could be more specific about where to find the "Start" button. Consider: "Under Distance, select Start GPS – Click Start at the beginning of your trip..."
  • Line 84: The description "automatically calculates your mileage amount using GPS while you travel" is good but could mention the app needs to remain open/active for accurate tracking
  • Consistency: Line 75 mentions clicking "Start" and "Stop" buttons, but doesn't explicitly state this is the "Start GPS" option (though it's implied by the section structure)
  • User expectations: Consider adding a note about GPS accuracy requirements or what to do if GPS is unavailable

Recommendations

  1. Enhance clarity on line 75: Make it explicit that "Start GPS" is the option being selected before the instructions
  2. Add cross-reference: Consider linking to any GPS troubleshooting documentation if it exists
  3. Consistency check: Ensure the instruction format matches other distance tracking options (both use "–" for descriptions)
  4. Future consideration: A brief mention of GPS permissions or battery usage might help set user expectations

Files Reviewed

  • /docs/articles/expensify-classic/expenses/Add-an-expense.md - Approved with minor suggestions - Accurately updates GPS mileage tracking documentation from "unavailable" to active feature with clear instructions

Overall Score: 8/10

This is a solid documentation update that accurately reflects a new feature. The changes are clear, consistent, and ready for merge. The suggestions above are minor enhancements that could improve user experience but are not blockers.


Review completed by HelpDot Documentation Quality Specialist

2. Under **Distance**, select:
- **Manually create** – enter miles and rate. Tap **More options** for category, description, report.
- **Odometer** – enter pre/post trip readings and rate. Tap **More options** to complete.
- **Start GPS** – Click **Start** at the start of your trip, and click **Stop** when you reach your destination. For best results, keep the Expensify app open.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Button label inconsistency: The text uses both "Click Start" and "click Stop" with inconsistent capitalization. Per Expensify style guidelines, button actions should be consistently capitalized. Recommend: "Tap Start" and "tap Stop" to match the mobile context (this section is under "On Mobile").

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kadiealexander I agree with this recommendation.

- **Manually create** – enter miles and rate.
- **Odometer** – log before/after readings.
- **Start GPS** – currently unavailable.
- **Start GPS** – automatically calculates your mileage amount using GPS while you travel.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Readability improvement: The phrase "automatically calculates your mileage amount using GPS while you travel" is somewhat verbose. Consider simplifying to: "automatically tracks your mileage using GPS" for better scannability and clarity.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kadiealexander I agree with this recommendation.

@github-actions github-actions bot changed the title Update Add-an-expense.md [No QA] Update Add-an-expense.md Nov 14, 2025
@OSBotify
Copy link
Contributor

OSBotify commented Nov 14, 2025

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

Updated articles:

@sakluger
Copy link
Contributor

Hey @kadiealexander, could you please address the github-actions recommendations? Othrewise, this looks great 👍

@kadiealexander
Copy link
Contributor Author

Updated!

@sakluger sakluger merged commit eaa1228 into main Nov 19, 2025
12 of 13 checks passed
@sakluger sakluger deleted the kadiealexander-patch-4 branch November 19, 2025 19:12
@melvin-bot melvin-bot bot added the Emergency label Nov 19, 2025
@melvin-bot
Copy link

melvin-bot bot commented Nov 19, 2025

@sakluger 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.

@sakluger
Copy link
Contributor

This is just a text update on a help doc, we didn't need all the checks to pass.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/sakluger in version: 9.2.62-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.2.62-5 🚀

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