Skip to content

[No QA] Docs updates for E/A#104591 Add Compare filter to How to Use Insights - #104796

Merged
stephanieelliott merged 1 commit into
mainfrom
claude-docsInsightsCompareFilter
Oct 26, 2026
Merged

stephanieelliott merged 1 commit into
mainfrom
claude-docsInsightsCompareFilter

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Enable Insights on desktop web (Expensify/App#104591) turns on the insightsCompare beta for all desktop web users. That adds a Compare control to the Insights filter bar, with Previous period and Average options.

This made a sentence in How to Use Insights incorrect:

You can adjust the data shown across Insights using three shared filters:

Web users now see a fourth shared filter. This PR changes "three shared filters" to "these shared filters" and adds one Compare bullet. The bullet says the filter is only available on web, because mobile still requires the beta.

Labels were checked against src/languages/en.ts and the live web UI.

Fixed Issues

$ #104591
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.

  • Verify that no errors appear in the JS console

Offline tests

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 verified any copy / text that was added to the app 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 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 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.
  • If the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • 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

UI verification by MelvinBot on desktop web:

Insights filter bar showing Date, Compare, and Group currency Compare popover with Previous period and Average options

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

Co-authored-by: Carlos Martins <luacmartins@users.noreply.github.com>
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Oct 22, 2026
@MelvinBot
MelvinBot requested a review from a team October 22, 2026 19:34
@github-actions github-actions Bot changed the title Docs updates for E/A#104591 Add Compare filter to How to Use Insights [No QA] Docs updates for E/A#104591 Add Compare filter to How to Use Insights Oct 22, 2026
@OSBotify

Copy link
Copy Markdown
Contributor

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

Updated articles:

@stephanieelliott
stephanieelliott marked this pull request as ready for review October 26, 2026 20:30
@stephanieelliott
stephanieelliott self-requested a review as a code owner October 26, 2026 20:30
@melvin-bot

melvin-bot Bot commented Oct 26, 2026

Copy link
Copy Markdown

Product 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?

cc @trjExpensify

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-26T20:54:44.427951Z 01faa55 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@melvin-bot
melvin-bot Bot requested review from trjExpensify and removed request for a team October 26, 2026 20:30
@melvin-bot

melvin-bot Bot commented Oct 26, 2026

Copy link
Copy Markdown

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


You can adjust the data shown across **Insights** using three shared filters:
You can adjust the data shown across **Insights** using these shared filters:

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.

Naming/consistency (minor): The other filter bullets follow a parallel "Choose..." structure (e.g. "Choose the period you want to analyze."). Per HELPSITE_NAMING_CONVENTIONS.md, use choose when a member decides between options. Consider rewording to match, e.g. "Compare: Choose Previous period or Average to compare spending. This filter is only available on web." This keeps the list parallel and uses the governance-preferred verb for selecting between options.

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR makes a small, targeted copy update to How-to-Use-Insights.md to reflect the newly enabled insightsCompare beta on desktop web. It changes "three shared filters" to "these shared filters" (the count is now variable by platform) and adds a Compare bullet describing the new filter with its Previous period and Average options, noting the filter is web-only. The change is accurate, minimal, and consistent with the existing bulleted filter list.

Scores Summary

  • Readability: 9/10 - The new bullet is clear, concise, and parallel with the existing Date, Workspace, and Group currency bullets. "these shared filters" is slightly less precise than "three," but is correct given the variable count across platforms.
  • AI Readiness: 8/10 - Full feature labels are used verbatim (Compare, Previous period, Average), reinforcing retrieval. The change sits under the task-based "How to filter insights" heading and introduces no heading or hierarchy issues. No metadata changes were needed for this scope.
  • Style Compliance: 8/10 - UI labels are bolded and match the UI, sentence case is correct, and the platform note correctly uses "web" rather than "the web," "website," or "desktop." One nit: the naming conventions specify the exact pattern "This feature is only available on web. It is not available on mobile." The bullet uses "This filter is only available on web." which is acceptable in spirit but omits the paired "It is not available on mobile." sentence.

Key Findings

  • Accurate reflection of shipped behavior: the Compare filter and its two options match the UI, and the web-only limitation is correctly scoped (mobile still requires the beta).
  • UI labels are bolded and verbatim, consistent with Core UI Referencing Rules.
  • The new bullet keeps parallel structure and sentence case with the existing list, aiding scannability.
  • Minor deviation from the canonical platform-limitation phrasing in HELPSITE_NAMING_CONVENTIONS.md (missing the "It is not available on mobile." half of the pattern).

Recommendations

  • Optional: align the platform note with the documented pattern, e.g. "Only available on web. It is not available on mobile." to fully match HELPSITE_NAMING_CONVENTIONS.md.
  • No structural, metadata, or heading changes required; the diff is in good shape as-is.

Files Reviewed

  • docs/articles/new-expensify/insights/How-to-Use-Insights.md - Approved with a minor optional phrasing suggestion.

Note: Detailed line-by-line feedback has been provided as inline comments.

@stephanieelliott
stephanieelliott merged commit a007ff4 into main Oct 26, 2026
24 of 26 checks passed
@stephanieelliott
stephanieelliott deleted the claude-docsInsightsCompareFilter branch October 26, 2026 20:37
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.5.24-1 🚀

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

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