Skip to content

[No QA] Add odometer distance expense docs to help site#86366

Merged
Julesssss merged 4 commits intomainfrom
jules-odometerHelpDocs
Apr 7, 2026
Merged

[No QA] Add odometer distance expense docs to help site#86366
Julesssss merged 4 commits intomainfrom
jules-odometerHelpDocs

Conversation

@Julesssss
Copy link
Copy Markdown
Contributor

@Julesssss Julesssss commented Mar 25, 2026

Add Odometer expense feature details:

  • Feature steps
  • FAQs

Tracking Issue: https://github.com/Expensify/Expensify/issues/571644

Holding until feature is about to go live.


Screenshot 2026-03-25 at 16 05 26 Screenshot 2026-03-25 at 16 05 11

@github-actions github-actions bot changed the title Add odometer distance expense docs to help site [No QA] Add odometer distance expense docs to help site Mar 25, 2026
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Mar 25, 2026

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

Updated articles:

@Julesssss Julesssss marked this pull request as ready for review March 26, 2026 17:33
@Julesssss
Copy link
Copy Markdown
Contributor Author

Hi @VictoriaExpensify @stephanieelliott and maybe @trjExpensify.

We're about to remove the feature for the Odometer feature. Could you please review and merge when you have a moment, thank you.

@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds odometer distance expense documentation to the existing Distance Expenses help page. The changes are well-structured: metadata is properly updated, the new procedural section follows the established pattern of the article, and the FAQ entries address practical user questions. However, there are several governance compliance issues in the proposed changes that should be addressed before merging.

Scores Summary

  • Readability: 8/10 - Steps are clear, sequential, and action-oriented. The procedure follows the same logical flow as the existing sections. Minor inconsistency in verb choice (step 5 uses "Tap" while other steps use "Select") slightly disrupts the scannability of the section.
  • AI Readiness: 9/10 - Metadata is thoroughly updated with relevant odometer keywords. The heading uses the required "How to" format with the feature name. The internalScope accurately reflects the expanded coverage. Strong alignment with search intent.
  • Style Compliance: 6/10 - Multiple governance violations were identified in the proposed changes: a full URL is used instead of a relative link, mixed action verbs within a single section ("Tap" vs. "Select"), and the prohibited word "Click" appears in the last FAQ entry. These are clear violations of HELPSITE_NAMING_CONVENTIONS.md and HELP_AUTHORING_GUIDELINES.md.

Key Findings

Issues that must be addressed:

  1. Full URL instead of relative link (HELP_AUTHORING_GUIDELINES.md Section 7): The cross-link to "Create and Submit Reports" uses a full URL. The governance rules explicitly state: "Use relative links only. Do not use full URLs." This should be converted to a relative path. Note: This violation also exists in the old version of the file, but since this line was modified in the diff (trailing whitespace removed, making it a changed line), it is within scope for this review.

  2. Mixed action verbs within the Odometer section (HELPSITE_NAMING_CONVENTIONS.md - Deterministic Writing Rule): Step 5 uses "Tap the image icon" while all other steps in this section (and the heading label "Web and Mobile") use "Select." The governance rules require consistency: "Be literal. Be exact. Be consistent. Avoid stylistic variation." Since this section covers both Web and Mobile, "Select" should be used throughout, or platform-specific instructions should be separated per the Navigation Instruction Standards.

  3. Prohibited verb "Click" in FAQ (HELPSITE_NAMING_CONVENTIONS.md): The last FAQ answer states "Click on the image preview to view the original uncropped images." The rest of the article uses "Select" for cross-platform instructions. Per the Deterministic Writing Rule and the Cross-Platform Clarity Rule, "Select" should be used consistently. If this action is web-only, it should be stated explicitly.

Positive aspects:

  • Metadata updates are thorough and well-crafted. The new keywords (odometer, odometer reading, odometer image, odometer mileage, odometer distance, start reading, end reading) reflect realistic search queries.
  • The heading "How to create a Distance expense using Odometer readings (Web and Mobile)" is task-based, includes the feature name, and specifies platform availability -- all in compliance with governance rules.
  • The step structure is clear, sequential, and mirrors the established pattern of the other distance expense sections.
  • FAQ questions start with question words (Can), which complies with the heading rules.
  • The internalScope update accurately reflects the expanded scope of the article.

Recommendations

Priority (must fix):

  1. Convert the full URL cross-link to a relative link: [Create and Submit Reports](/articles/new-expensify/reports-and-expenses/Create-and-Submit-Reports)
  2. Change step 5 from "Tap the image icon" to "Select the image icon" (or use the exact UI label if different) for consistency with the rest of the section.
  3. Change "Click on the image preview" in the last FAQ to "Select the image preview" for cross-platform consistency.

Suggestions (nice to have):

  • Consider whether "image icon" in step 5 is the exact UI element label. Per HELPSITE_NAMING_CONVENTIONS.md, UI elements should be referenced by their exact label and bolded if they are interactive elements.
  • The existing cross-links in other (unchanged) sections of this article also use full URLs rather than relative links. While out of scope for this PR, a follow-up cleanup would bring the entire article into compliance.

Files Reviewed

  • docs/articles/new-expensify/reports-and-expenses/Distance-Expenses.md - New odometer section added with metadata updates, procedural steps, and three FAQ entries. Requires fixes for link formatting, verb consistency, and UI terminology before merging.

Review based on governance rules defined in docs/HELPSITE_NAMING_CONVENTIONS.md, docs/HELP_AUTHORING_GUIDELINES.md, and docs/TEMPLATE.md.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b1cfbfbefd

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".


## Can I add two odometer images to a distance expense?

When you add two odometer images to a distance expense, they will be merged into a single image for easy viewing. Click on the image preview to view the original uncropped images. You'll be able to replace or remove the combined image if you need to make a correction.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove claim that stitched odometer image is replaceable

The FAQ says users can replace or remove the combined odometer image, but stitched odometer receipts explicitly disable replacement in src/pages/media/AttachmentModalScreen/routes/TransactionReceiptModalContent.tsx via isStitchedOdometerReceipt and shouldShowReplaceReceiptButton, and the Replace button is hidden for that case. This creates a user-facing mismatch where the documented correction path is not available in the receipt preview UI.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@Julesssss is this true? I can 't find the ad hoc build to test, but it seems like the ND feature was designed so the image could be replaced, right?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

They can update the cropped photo by replacing individual start/end photos. But that is prior to expense creation... I will simplify this FAQ

@stephanieelliott
Copy link
Copy Markdown
Contributor

Reviewing!

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@stephanieelliott
Copy link
Copy Markdown
Contributor

@Julesssss I committed a couple bot suggestions, just one open question for you in the file re: whether the image can be deleted or not. If the help site language is correct, feel free to dismiss that comment.

Other than, that this is ready to publish! We'll just want to time this so that it's published when the feature hits prod (not before, as AZ will start telling people about it) -- feel free to merge it yourself at that time.

@Julesssss
Copy link
Copy Markdown
Contributor Author

Thanks @stephanieelliott! I clarified that FAQ with a simplified answer.

Great, I'll hold this until the beta is removed.

@stephanieelliott stephanieelliott removed the request for review from VictoriaExpensify March 26, 2026 21:36
@stephanieelliott stephanieelliott changed the title [No QA] Add odometer distance expense docs to help site [HOLD for feature release] [No QA] Add odometer distance expense docs to help site Mar 26, 2026
@Julesssss
Copy link
Copy Markdown
Contributor Author

Pretty sure this goes live once it hits main. So I'll merge this next week shortly after we remove the beta.

@Julesssss Julesssss changed the title [HOLD for feature release] [No QA] Add odometer distance expense docs to help site [No QA] Add odometer distance expense docs to help site Apr 7, 2026
@Julesssss
Copy link
Copy Markdown
Contributor Author

Feature is live!

@Julesssss Julesssss merged commit 3eb8d30 into main Apr 7, 2026
15 checks passed
@Julesssss Julesssss deleted the jules-odometerHelpDocs branch April 7, 2026 17:35
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 8, 2026

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.3.54-0 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 9, 2026

🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.54-7 🚀

platform result
🕸 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