Skip to content

[No QA] Create Set-Up-Traveler-Messaging.md - #83392

Merged
stephanieelliott merged 4 commits into
mainfrom
strepanier03-travel-messaging
Feb 26, 2026
Merged

stephanieelliott merged 4 commits into
mainfrom
strepanier03-travel-messaging

Conversation

@strepanier03

@strepanier03 strepanier03 commented Feb 24, 2026 •

Copy link
Copy Markdown
Contributor

Per this https://expensify.slack.com/archives/C05S5EV2JTX/p1770220769286929 in Slack, we have enabled Traveler Messaging for travel customers, so we need a help doc.

I confirmed multiple travel customers have the option available to them when viewing their travel setup.

Explanation of Change

Fixed Issues

$
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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 / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 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)
  • 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.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(themeColors.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 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.
  • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

Per this https://expensify.slack.com/archives/C05S5EV2JTX/p1770220769286929 in Slack, we have enabled Traveler Messaging for travel customers, so we need a help doc.

I confirmed multiple travel customers have the option available to them when viewing their travel setup.
@strepanier03 strepanier03 self-assigned this Feb 24, 2026
@github-actions github-actions Bot changed the title Create Set-Up-Traveler-Messaging.md [No QA] Create Set-Up-Traveler-Messaging.md Feb 24, 2026
@OSBotify

OSBotify commented Feb 24, 2026 •

Copy link
Copy Markdown
Contributor

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

Updated articles:

@strepanier03
strepanier03 marked this pull request as ready for review February 24, 2026 23:10
@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds a new help article for Traveler Messaging, a feature recently enabled for travel customers. The article is well-structured, clearly written, and covers the full lifecycle of Traveler messaging (creating, targeting, publishing, viewing, and troubleshooting). It is a strong addition to the travel documentation set.

Scores Summary

  • Readability: 9/10 - Clear, concise language throughout. Steps are logically ordered and easy to follow. One minor formatting issue: the "Note:" on line 51 (after step 8) is not indented under the numbered list, which may break the visual flow of the step sequence.
  • AI Readiness: 9/10 - Descriptive headings use full task phrasing (e.g., "How to target Traveler Messaging to specific employees"). YAML metadata is complete and well-formed, including a properly structured internalScope field. Heading hierarchy is clean (H1, H2, H3 only where appropriate).
  • Style Compliance: 8/10 - Generally follows Expensify documentation conventions. A few items to note below.

Key Findings

Positive aspects:

  • The YAML front matter is thorough: title, description, keywords, and internalScope are all present and well-written. The internalScope follows the correct "Audience is... Covers... Does not cover..." pattern.
  • The article uses consistent, descriptive section headings that make the document easy to scan and highly AI-parseable.
  • The FAQ section is well-chosen, addressing the most likely user questions (message not appearing, ideal length, email vs. banner, editing published messages).
  • The audience conditions list is comprehensive and will serve as a useful reference for Travel Admins.
  • The article is written at an accessible reading level with no unnecessary jargon.

Items to address:

  1. Missing "How to access Expensify Travel" section. Other articles in the company-setup directory (e.g., Configuring-Email-Notifications.md, Managing-Users.md) include a standard "How to access Expensify Travel" section near the top with instructions for both New Expensify and Classic Expensify. This article omits it and instead jumps to "Where to find Traveler Messaging" with navigation steps that assume the user is already inside the Travel tool. Consider adding the standard access section for consistency with the rest of the travel documentation.

  2. Note formatting on line 51. The line Note: The message will only display during the time period you define. sits between steps 8 and 9 but is not indented to align with the list. This breaks the numbered list continuity in most Markdown renderers. It should either be indented under step 8 or reformulated as part of step 8 (e.g., 8. Set the **End date and time**. The message will only display during the time period you define.).

  3. Capitalization inconsistency in headings. The H2 headings alternate between capitalizing "Messaging" (e.g., "How to create Traveler Messaging") and using lowercase "messaging" in the body text (e.g., "Traveler messaging allows..."). The article title in the YAML uses "Traveler Messaging" (capitalized), and the H1 also uses "Traveler Messaging." It would be cleaner to pick one convention and apply it consistently. Given that this is a feature name, capitalizing it as "Traveler Messaging" in headings is reasonable, but body text should ideally follow the same pattern or intentionally use lowercase as a common noun. Other travel docs (e.g., Configuring-Email-Notifications.md) tend to lowercase feature references in body text, so the current mixed approach is acceptable but worth a conscious decision.

  4. Keywords include "Spotnana." The keyword Spotnana message in the YAML front matter references the underlying third-party platform. This may be intentional for SEO purposes (users searching for Spotnana), but it is worth confirming this is desired, since other travel docs do not reference Spotnana in their keywords.

  5. No "How to access Expensify Travel" or platform context. Unlike peer articles, this document does not mention whether the instructions apply to New Expensify, Classic Expensify, or both. The "On web or mobile" H3 subheading partially addresses this, but the standard pattern used in sibling docs provides explicit entry points for both platforms.

Recommendations

  1. (Medium priority) Add the standard "How to access Expensify Travel" section used by other travel company-setup articles, or at minimum clarify which Expensify platform(s) support this feature.
  2. (Low priority) Fix the unindented "Note:" on line 51 so it does not break the numbered list rendering.
  3. (Low priority) Confirm whether "Spotnana" should remain in the keywords, or if it should be removed for brand consistency.
  4. (Optional) Consider adding a brief note about what happens when multiple audience groups are created (the article explains AND logic within a group but does not clarify whether multiple audience groups use OR logic between them).

Files Reviewed

  • docs/articles/travel/company-setup/Set-Up-Traveler-Messaging.md (166 lines added) -- New article. Well-written and comprehensive. Minor formatting and consistency items noted above.

This review covers only the proposed changes in the PR diff. Scores and feedback are based solely on added content.

strepanier03 and others added 2 commits February 24, 2026 15:15
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@strepanier03

Copy link
Copy Markdown
Contributor Author

@stephanieelliott - Just a question about level 3 headers (aka "###" headers). The SDO suggested them but the AI Readiness is saying don't use them.

Is it okay to ignore the AI readiness for level 3 headers if it makes sense in the doc and helps with formatting and the flow of information?

If not, can we update the SDO to not use them?

@stephanieelliott

Copy link
Copy Markdown
Contributor

@strepanier03 ah yeah the SDO loses some consistently and needs to be readjusted as it is "upgraded" to newer GPT models. I will update it to be more accurate on the headings!

No ### is not a hard and fast rule, but we should use it deliberately -- here is what the SDO says about it:

HelpDot content is chunked and embedded before being stored in Pinecone. Deep heading nesting (###, ####) can:

Create overly small chunks
Fragment semantically related content
Reduce the likelihood that a single chunk fully answers a user query
Lower retrieval confidence scores

Applying that to this bot suggestion, I think we should avoid the H3 heading as it would separate the instructions from the actual query (## Where to find Traveler Messaging).

@strepanier03

Copy link
Copy Markdown
Contributor Author

Gotcha, that framing makes sense. I'll tweak this and let you know when it's ready for your review again.

made some formatting updates to reduce level 3 headings.

@strepanier03 strepanier03 left a comment

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.

I made the updates to the level three headers and think it looks a lot better, thanks for the recommendation @stephanieelliott!

@stephanieelliott

Copy link
Copy Markdown
Contributor

Thanks @strepanier03, looks great!

@stephanieelliott
stephanieelliott merged commit ca56753 into main Feb 26, 2026
14 checks passed
@stephanieelliott
stephanieelliott deleted the strepanier03-travel-messaging branch February 26, 2026 22:33
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.3.27-0 🚀

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

@OSBotify

OSBotify commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/blimpich in version: 9.3.27-8 🚀

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