Skip to content

[No QA] Docs updates for E/A#94217 document Describe your search on Spend page - #102158

Draft
MelvinBot wants to merge 1 commit into
mainfrom
melvin-docs-describe-your-search
Draft

MelvinBot wants to merge 1 commit into
mainfrom
melvin-docs-describe-your-search

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Documents the Describe your search natural-language filter entry point added to the Spend page by [Payment due @truph01] Add natural language filter entry point to Spend page. That PR shipped a new user-facing feature and copy with no accompanying help site coverage, so members have no documentation for it.

New article: docs/articles/new-expensify/reports-and-expenses/Describe-Your-Search-on-the-Spend-Page.md

It covers the single workflow of describing a search in plain English, including:

  • Who can use Describe your search (any member, no role or plan requirement).
  • How to use it on web (hover Describe your search at the top of the left column in the Filters popup, so the Your search field appears in the right panel) and on mobile (tap it in the filter list to open its own screen).
  • How a description becomes filters — dates, amounts, categories, expense types, and keywords — and why a description that matches no workspace category falls back to a keyword search.
  • What to do when an error appears, including question-style descriptions and being offline.
  • An FAQ covering editing filters afterward, keyword vs. category matching, offline behavior, and errors.

Updated articles (one cross-link each, per the cross-linking standards):

  • Getting-Started-with-the-Spend-Page.md — adds a pointer from the filters section and adds describe-search keywords to the front matter.
  • Use-Search-Operators-to-Filter-and-Analyze.md — adds a pointer for members who would rather not write operator syntax.

How the copy was verified: every UI label in the article was checked against the running app rather than taken from the diff — the Spend tab, the Filters button, the Describe your search entry point, the Your search input label, the description text, and the Apply button. All match the article exactly, including capitalization.

The article follows docs/HELP_AUTHORING_GUIDELINES.md (one workflow, one # heading plus # FAQ, task-based ## headings only, required front matter including internalScope), docs/HELPSITE_NAMING_CONVENTIONS.md (bolded UI labels in sentence case, separate web and mobile navigation), and docs/TEMPLATE.md.

Note for the reviewer: the Fixed Issues link is intentionally left blank — please add the correct issue link before marking this ready for review.

AI Tests

  • npm run spell-changed — passed (3 files checked, 0 issues).
  • No other checks from the test selection matrix apply: this change touches only docs/articles/** markdown, and the generated docs/_data/routes.yml is gitignored, so no routes file needs to be committed.

Fixed Issues

$
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

N/A — this is a documentation-only change with no app code.

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 followed proper code patterns (see Reviewing the code)
    • 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 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)
  • 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)
  • 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 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.
  • 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

@marcaaron, 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: Marc Glasser <marcaaron@users.noreply.github.com>
@MelvinBot
MelvinBot requested a review from a team September 24, 2026 13:02
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Sep 24, 2026
@stephanieelliott stephanieelliott changed the title Docs updates for E/A#94217 document Describe your search on Spend page [No QA] Docs updates for E/A#94217 document Describe your search on Spend page Oct 6, 2026

This branch has not been deployed

No deployments
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.

2 participants