Skip to content

[No QA] Create Using-search-operators.md#70257

Merged
zanyrenney merged 4 commits into
mainfrom
stephanieelliott-patch-15
Nov 14, 2025
Merged

[No QA] Create Using-search-operators.md#70257
zanyrenney merged 4 commits into
mainfrom
stephanieelliott-patch-15

Conversation

@stephanieelliott

@stephanieelliott stephanieelliott commented Sep 10, 2025

Copy link
Copy Markdown
Contributor

@stephanieelliott stephanieelliott self-assigned this Sep 10, 2025
@OSBotify

OSBotify commented Sep 10, 2025

Copy link
Copy Markdown
Contributor

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

Updated articles:

@stephanieelliott stephanieelliott marked this pull request as ready for review September 22, 2025 00:25
@stephanieelliott stephanieelliott requested a review from a team as a code owner September 22, 2025 00:25
@melvin-bot

melvin-bot Bot commented Sep 22, 2025

Copy link
Copy Markdown

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

@melvin-bot

melvin-bot Bot commented Sep 22, 2025

Copy link
Copy Markdown

@MonilBhavsar @RachCHopkins One of you needs to 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 September 22, 2025 00:26

@JmillsExpensify JmillsExpensify left a comment

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.

Made a couple of comments about the section in the beginning. Everything else looks good!

Comment thread docs/articles/new-expensify/reports-and-expenses/Using-search-operators.md Outdated
Comment thread docs/articles/new-expensify/reports-and-expenses/Using-search-operators.md Outdated
Comment thread docs/articles/new-expensify/reports-and-expenses/Using-search-operators.md Outdated
Comment thread docs/articles/new-expensify/reports-and-expenses/Using-search-operators.md Outdated
@stephanieelliott

Copy link
Copy Markdown
Contributor Author

Just noting here that once this is published we'll want to cross-link this doc on Getting-Started-with-the-Reports-Page.md

Comment thread docs/articles/new-expensify/reports-and-expenses/Using-search-operators.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR introduces a comprehensive guide for Expensify's search operator framework covering expenses, reports, chats, and tasks. The documentation provides thorough technical coverage with clear examples and structured filtering options. The content is well-organized and addresses a complex feature with systematic detail.

Scores Summary

  • Readability: 8/10 - Clear structure with good use of examples and tables, though some technical density remains
  • AI Readiness: 9/10 - Excellent metadata, descriptive headings, and comprehensive context
  • Style Compliance: 7/10 - Generally follows HelpDot standards but has some formatting inconsistencies

Key Findings

Strengths:

  • Excellent YAML metadata with comprehensive keywords and clear description
  • Well-structured content with logical flow from basic concepts to advanced usage
  • Rich examples throughout showing practical application of search operators
  • Comprehensive coverage of all object types (expenses, reports, chats, tasks)
  • Good use of code blocks and tables for technical reference
  • FAQ section addresses common user questions
  • Proper use of HTML div wrapper for New Expensify content

Areas for Improvement:

  • Navigation references could be more specific and consistent
  • Some repetitive phrasing in navigation instructions
  • Table formatting could be enhanced for better readability
  • Minor inconsistencies in terminology usage

Recommendations

Priority Actions:

  1. Standardize navigation language: Replace repetitive phrase about navigation tabs with more concise alternatives
  2. Enhance table accessibility: Consider adding table headers and improving mobile responsiveness for complex tables
  3. Clarify feature availability: Add context about which search operators are available on different platforms (web vs mobile)

Style Enhancements:

  • Consider breaking up dense technical sections with more subheadings
  • Add brief introductory sentences before major tables
  • Ensure consistent use of Expensify terminology (workspace vs company)

Files Reviewed

  • docs/articles/new-expensify/reports-and-expenses/Using-search-operators.md - Comprehensive new documentation with strong technical content and good structure

Overall Score: 8/10 - This is high-quality documentation that effectively covers a complex technical feature with clear examples and comprehensive reference material. The minor formatting and consistency issues do not detract significantly from the overall value.

Merge Readiness: ✅ READY - The documentation provides substantial value to users and follows HelpDot standards. Recommended improvements can be addressed in future iterations without blocking this contribution.

Note: This review covers the comprehensive assessment of documentation quality, readability, and compliance with HelpDot standards.

Comment thread docs/articles/new-expensify/reports-and-expenses/Using-search-operators.md Outdated

Here are the core rules and behaviors you’ll use across all filters:

- `field:value` is the basic format.

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.

Clarity violation: Be more specific about location. Instead of "on the left (web)", use "in the left sidebar" for better clarity across platforms.

@github-actions github-actions Bot changed the title Create Using-search-operators.md [No QA] Create Using-search-operators.md Oct 15, 2025
@stephanieelliott stephanieelliott changed the title [No QA] Create Using-search-operators.md [HOLD] [No QA] Create Using-search-operators.md Oct 20, 2025
@zanyrenney

Copy link
Copy Markdown
Contributor

A lottttt of these GH actions are not relevant because this is about search syntax so the style and formatting aren't perfect.

@zanyrenney zanyrenney changed the title [HOLD] [No QA] Create Using-search-operators.md [No QA] Create Using-search-operators.md Nov 13, 2025
@zanyrenney zanyrenney assigned zanyrenney and unassigned zanyrenney Nov 13, 2025
@zanyrenney zanyrenney self-requested a review November 13, 2025 16:28

@zanyrenney zanyrenney left a comment

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.

reviewed these 1:1 they are all good. this page is a bit unique in that it is syntax so more technical.

@zanyrenney

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I verified proper code patterns were followed (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 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
    • 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 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)
    • 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 verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • 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.ts or at the top of the file that uses the constant) are defined as such
  • 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
    • 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(theme.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 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 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

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

@zanyrenney

Copy link
Copy Markdown
Contributor

Saw this was still failing:
image

But the PR checklist is above

@grgia

grgia commented Nov 14, 2025

Copy link
Copy Markdown
Contributor

merged main for the workflow validation (affected any PRs opened before oct)

@zanyrenney zanyrenney merged commit 5046eb4 into main Nov 14, 2025
16 checks passed
@zanyrenney zanyrenney deleted the stephanieelliott-patch-15 branch November 14, 2025 09:46
@melvin-bot

melvin-bot Bot commented Nov 14, 2025

Copy link
Copy Markdown

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

@zanyrenney

Copy link
Copy Markdown
Contributor

Thanks @grgia !

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/zanyrenney in version: 9.2.59-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/grgia in version: 9.2.59-5 🚀

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

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.

5 participants