Skip to content

[No QA] Docs updates for E/A#85493 Add distance editing to Distance Expenses article#90012

Merged
sakluger merged 3 commits into
mainfrom
docs/update-distance-editing-85493
May 15, 2026
Merged

[No QA] Docs updates for E/A#85493 Add distance editing to Distance Expenses article#90012
sakluger merged 3 commits into
mainfrom
docs/update-distance-editing-85493

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new "How to edit the distance on an existing Distance expense" section to the Distance Expenses help article, documenting the new Map and Manual editing tabs
  • Updates the FAQ entry about editing distance expenses to mention the new distance editing capability
  • Adds editing-related keywords to the article metadata

Related PR: #85493

Test plan

  • Verify the new section accurately reflects the UI flow for editing distance on an existing expense
  • Verify tab names (Map, Manual) match the actual UI labels
  • Verify the article renders correctly on the help site

Update the Distance Expenses help article to document the new ability
to edit distance on existing expenses via Map and Manual tabs.

Co-authored-by: Mukhriddin Shakhriyorov <mukhrr@users.noreply.github.com>
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label May 8, 2026
@stephanieelliott stephanieelliott marked this pull request as ready for review May 11, 2026 20:41
@stephanieelliott stephanieelliott self-requested a review as a code owner May 11, 2026 20:41
@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds a new section explaining how to edit the distance on an existing Distance expense, updates YAML metadata to reflect the new editing coverage, and expands the related FAQ answer. The changes are well-structured, concise, and follow governance standards closely. A few minor items are noted below.

Scores Summary

  • Readability: 9/10 - Clear, scannable steps with good use of bold formatting for UI elements. The bullet list explaining Map vs. Manual before the numbered steps is a helpful pattern.
  • AI Readiness: 9/10 - The new heading is task-based and includes the feature name. Keywords and internalScope are updated with relevant edit-related search phrases. Description properly reflects the expanded scope.
  • Style Compliance: 8/10 - UI elements are bolded correctly (Distance, Map, Manual, Save). One minor concern: the heading and steps reference "the distance on an existing Distance expense" and "the Distance field" -- verify that the UI label is literally "Distance" (capitalized) as a field name. If the field shows differently in the product, the label should be adjusted to match exactly. Additionally, the FAQ answer mentions "the Map tab" and "the Manual tab" -- the new procedural section calls them options from "the top row" rather than tabs, which is a slight inconsistency in terminology.

Key Findings

  • The new "How to edit the distance on an existing Distance expense" section follows the required task-based heading format and uses the feature name, satisfying AI retrieval rules.
  • Step formatting is sequential, action-oriented, and concise -- aligning with Step Formatting Standard (Section 5 of authoring guidelines).
  • Keywords added ("edit distance", "edit route", "edit mileage", "update distance", "change distance") reflect realistic user search queries.
  • The FAQ expansion adds useful inline context rather than just linking away, which improves self-contained readability.
  • Minor terminology inconsistency: the FAQ uses "Map tab" and "Manual tab" while the procedural section uses "Map" and "Manual" as selectable options from "the top row." Consider aligning the FAQ wording to match the procedural section (e.g., "select Map" / "select Manual" instead of "the Map tab" / "the Manual tab") unless the UI explicitly labels these as tabs.
  • Step 1 ("Open the Distance expense") uses a slightly vague action. Per naming conventions, consider specifying the navigation path or at minimum clarifying where the user opens it from (e.g., selecting it from a report or chat).

Recommendations

  1. Verify that Distance is the exact UI field label shown in the product. If it differs, update to match.
  2. Align FAQ terminology with the procedural section -- either consistently call them "tabs" or consistently describe them as selectable options.
  3. Consider whether Step 1 could be more specific about where/how to open the expense (e.g., "Open the expense from a report or chat"), though this may be acceptable given the article already covers creation flows above.

Files Reviewed

  • docs/articles/new-expensify/reports-and-expenses/Distance-Expenses.md -- Metadata updated, new editing section added, FAQ answer expanded. Changes are well-aligned with governance standards with minor terminology consistency items noted above.

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

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: 209ca792b2

ℹ️ 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".

Comment thread docs/articles/new-expensify/reports-and-expenses/Distance-Expenses.md Outdated
@stephanieelliott stephanieelliott self-assigned this May 12, 2026
@stephanieelliott stephanieelliott changed the title Docs updates for E/A#85493 Add distance editing to Distance Expenses article [No QA] Docs updates for E/A#85493 Add distance editing to Distance Expenses article May 15, 2026
Clarified the section title and improved the explanation for editing distance expenses.
@stephanieelliott stephanieelliott requested a review from a team May 15, 2026 02:29
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 15, 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 @sakluger

@melvin-bot melvin-bot Bot requested a review from sakluger May 15, 2026 02:29
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 15, 2026

@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 May 15, 2026 02:29
@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds a new section explaining how to edit an existing Distance expense (map or manual) and updates the corresponding FAQ answer to reflect the new editing capability. The changes are well-structured, concise, and align closely with the existing article style. Only minor issues were identified.

Scores Summary

  • Readability: 9/10 - Clear, scannable steps with a helpful introductory paragraph explaining the two editing methods before the procedure. The bullet list providing context on Map vs. Manual is a nice touch.
  • AI Readiness: 8/10 - The new heading "How to edit an existing Distance expense" is task-based and includes the feature name, which supports semantic retrieval well. However, the YAML keywords were not updated to include terms like "edit distance expense" or "update distance," which would improve search discoverability for this new content.
  • Style Compliance: 9/10 - UI elements are bolded correctly (Distance, Map, Manual, Save). Step formatting is sequential and action-oriented. The updated FAQ answer uses descriptive anchor text for the cross-link and keeps the link outside of numbered steps.

Key Findings

  • Positive: The new "How to edit an existing Distance expense" heading follows task-based heading rules (starts with "How to") and includes the feature name "Distance expense," satisfying AI retrieval optimization requirements.
  • Positive: The updated FAQ answer at line 150 replaces a generic redirect with specific inline guidance about the Distance field, Map tab, and Manual tab, making the article more self-contained. The cross-link to Managing Expenses in a Report uses descriptive anchor text and is placed outside numbered steps, which complies with cross-linking standards.
  • Positive: Bold formatting is applied consistently to all UI element references (Distance, Map, Manual, Save), matching the button and tab naming standards.
  • Minor issue: The YAML keywords array (line 4) and internalScope (line 5) were not updated to reflect the new editing workflow. Adding terms like "edit distance expense," "update distance," "edit mileage" to keywords and mentioning editing in the internalScope would improve search alignment per Section 3 (Metadata Requirements) and Section 6 (AI Retrieval Optimization) of the authoring guidelines.
  • Minor observation: The FAQ answer uses "tab" (e.g., "the Map tab") while the new procedural section uses an em dash style ("Map -- Update the start and stop locations..."). Both are acceptable, but the procedural steps at line 103 say "Select Map or Manual from the top row," which is consistent with other creation sections in the article. The slight terminology difference between "tab" in the FAQ and "from the top row" in the steps is worth noting for consistency, though both appear to reflect actual UI behavior.

Recommendations

  1. Update YAML keywords to include editing-related search terms (e.g., "edit distance expense", "update distance", "change distance route", "modify mileage").
  2. Update internalScope to mention that the article now also covers editing Distance expenses, not just creating them.
  3. Consider aligning terminology between the FAQ answer ("tab") and the procedural section ("from the top row") for consistency -- pick whichever matches the UI most precisely.

Files Reviewed

  • docs/articles/new-expensify/reports-and-expenses/Distance-Expenses.md -- 18 lines added (new "How to edit" section), 1 line modified (FAQ answer updated). Both changes are well-written and governance-compliant with minor metadata gaps noted above.


To edit the distance:

1. Open the Distance expense.
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.

Readability / structure (missing navigation path): "Open the Distance expense" does not tell the user how to navigate to the expense. Per HELPSITE_NAMING_CONVENTIONS.md, avoid vague navigation phrases and always reference the exact UI path. Consider providing a concrete navigation instruction, such as "Select the Distance expense from your chat or report" or specifying the screen where the user can find it.

@OSBotify
Copy link
Copy Markdown
Contributor

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

Updated articles:

@sakluger sakluger merged commit 8a6331d into main May 15, 2026
24 checks passed
@sakluger sakluger deleted the docs/update-distance-editing-85493 branch May 15, 2026 21:09
@melvin-bot melvin-bot Bot added the Emergency label May 15, 2026
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 15, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds a new procedural section explaining how to edit an existing Distance expense, and updates a related FAQ answer to provide more specific guidance. The changes are well-scoped, focused on a single workflow addition, and largely follow HelpDot governance standards. A few minor items could be tightened.

Scores Summary

  • Readability: 9/10 - The new section is clear, scannable, and follows proper step formatting. The bullet descriptions for Map vs. Manual are concise and informative. The FAQ update is slightly dense as a single sentence but remains understandable.
  • AI Readiness: 9/10 - The new heading "How to edit an existing Distance expense" is task-based, includes the feature name, uses a "How to" pattern, and sits at the correct ## level. YAML metadata (title, description, keywords, internalScope) already exists and the internalScope field does not mention editing, but this is a minor addition to an existing article rather than a new article, so the impact is low.
  • Style Compliance: 9/10 - UI elements are bolded correctly (Distance, Map, Manual, Save). Steps are sequential, action-oriented, and aligned with UI flow. The cross-link in the FAQ uses descriptive anchor text. One small note: the FAQ answer uses "Yes!" with an exclamation mark, which carries over from the existing text and is not part of this diff.

Key Findings

  • Positive: The new "How to edit an existing Distance expense" heading is a strong task-based heading that follows governance rules exactly -- it starts with "How to," includes the feature name "Distance expense," and uses the ## level correctly.
  • Positive: The two editing methods (Map and Manual) are clearly distinguished using bold labels and em-dash separators, making the content highly scannable.
  • Positive: Steps are concise (5 steps), sequential, and action-oriented, with no links embedded inside numbered steps -- compliant with cross-linking standards.
  • Minor: The updated FAQ answer packs multiple instructions into a single sentence. While not a violation, breaking it into two sentences would improve readability (e.g., separate the "how to edit distance" guidance from the cross-link to Managing Expenses).
  • Minor: The internalScope in the YAML frontmatter does not mention editing Distance expenses. Consider updating it to reflect the expanded coverage (e.g., "Covers creating and editing Distance expenses...").
  • Minor: The description and keywords fields in YAML do not reference editing distance expenses. Adding "edit distance expense" or "update distance" to keywords would improve search/retrieval for this new content.

Recommendations

  1. Update YAML metadata -- Add "edit distance expense" and "update distance" to the keywords array, and consider mentioning editing in the description and internalScope fields to improve AI retrieval for the new content.
  2. Split the FAQ answer -- Consider breaking the updated FAQ response into two sentences for improved scannability: one explaining how to edit the distance field, and a second sentence with the cross-link to Managing Expenses.
  3. No structural or compliance issues need to be addressed before merging.

Files Reviewed

  • docs/articles/new-expensify/reports-and-expenses/Distance-Expenses.md -- New "How to edit an existing Distance expense" section added; FAQ answer updated. Both changes are well-structured and governance-compliant with minor metadata improvement opportunities.

Note: This review assessed only the proposed changes (diff), not unchanged portions of the file.

@OSBotify
Copy link
Copy Markdown
Contributor

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

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

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.77-3 🚀

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

HelpDot Apply this label if the issue relates to ExpensifyHelp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants