Skip to content

Update Book-Rail-Travel.md#79061

Merged
stephanieelliott merged 1 commit into
stephanieelliott-patch-22from
stephanieelliott-patch-22-1
Jan 8, 2026
Merged

Update Book-Rail-Travel.md#79061
stephanieelliott merged 1 commit into
stephanieelliott-patch-22from
stephanieelliott-patch-22-1

Conversation

@stephanieelliott

Copy link
Copy Markdown
Contributor

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: 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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 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 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 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.
  • 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

@stephanieelliott stephanieelliott requested a review from a team as a code owner January 8, 2026 04:14
@melvin-bot

melvin-bot Bot commented Jan 8, 2026

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

@melvin-bot melvin-bot Bot requested review from NicMendonca and removed request for a team January 8, 2026 04:15
@stephanieelliott stephanieelliott merged commit bbcc58b into stephanieelliott-patch-22 Jan 8, 2026
5 of 7 checks passed
@melvin-bot

melvin-bot Bot commented Jan 8, 2026

Copy link
Copy Markdown

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

@stephanieelliott stephanieelliott deleted the stephanieelliott-patch-22-1 branch January 8, 2026 04:15
Book train tickets directly in Expensify Travel. This guide covers how to search, book, and view your rail itineraries in New Expensify.

# How to access the travel tool
## Where to find Expensify Travel

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.

AI Readiness violation: Heading is too vague. Change to "## Where to find Expensify Travel" for better context and AI understanding. Generic headings like "How to access the travel tool" don't help AI systems understand what feature is being described.


If you don’t see this option, contact your Account Manager or Concierge to schedule a travel demo and enable travel booking for your account.
If you don’t see **Book travel**, ask a Workspace Admin to [enable Expensify Travel](https://help.expensify.com/articles/travel/company-setup/Enable-Travel-on-a-Workspace) on the workspace.

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.

Terminology violation: Use "workspace" instead of "account" to align with Expensify's standard terminology. Travel is enabled on a workspace, not an account.


# What happens next
## What happens after booking with Expensify Travel

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.

AI Readiness violation: Heading is too vague. Change to "## What happens after booking with Expensify Travel" for better clarity and AI context. "What happens next" doesn't specify what action was taken.

## Can I book a train in Expensify Travel?
Yes. If travel is enabled on your account, you can search and book rail journeys directly in Expensify.
Yes. Once Expensify Travel is enabled for your workspace, you can book train tickets directly from the app.

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.

Terminology violation: Use "workspace" instead of "account". Should read: "If travel is enabled on your workspace, you can search and book rail journeys directly in Expensify."

@github-actions

github-actions Bot commented Jan 8, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR makes targeted improvements to the Book-Rail-Travel.md article, modernizing language and enhancing clarity. The changes align the documentation with current Expensify terminology and improve the user experience by providing clearer navigation instructions.

Scores Summary

  • Readability: 8/10 - The changes improve clarity and flow. The updated heading "Where to find Expensify Travel" is more user-friendly than "How to access the travel tool." The mobile-first language ("Tap the green ➕") is conversational and clear. However, the article retains some inconsistency in heading hierarchy depth.

  • AI Readiness: 7/10 - Mixed improvements here. The change from "What happens next" to "What happens after booking with Expensify Travel" provides better context and searchability. However, some headings still lack full feature context ("How to book rail travel" could be more specific like "How to book rail travel in Expensify Travel").

  • Style Compliance: 8/10 - Strong alignment with Expensify terminology standards. Correctly uses "Workspace Admin" (capitalized, as seen throughout other help docs) and "Expensify Travel" as the proper product name. The note formatting change from blockquote to bold is consistent with observed patterns in similar articles.

Key Findings

Positive aspects:

  • Modernizes access instructions with mobile-first language (green ➕ Create button)
  • Uses proper terminology: "Workspace Admin" instead of generic "account" references
  • Improves heading descriptiveness: "What happens after booking with Expensify Travel" provides clearer context
  • Simplifies and clarifies the availability note
  • Maintains consistent FAQ structure and tone

Areas for consideration:

  • Mixed heading hierarchy: The article now uses both level 1 (#) and level 2 (##) headings, whereas the template and some comparable articles favor consistent use of # for main sections
  • The main booking section "How to book rail travel" remains as # while new sections use ##, creating potential navigation inconsistency

Recommendations

  1. High Priority: Consider standardizing all main section headings to use either all # or all ## for consistency. Review other travel booking articles (Book-a-Flight.md, Book-a-Hotel.md) which consistently use # for all main sections.

  2. Enhancement: The main section "How to book rail travel" could benefit from more context like "How to book rail travel in Expensify Travel" for better AI searchability and standalone clarity.

  3. Consistency Check: Ensure the mobile navigation pattern ("Tap the green ➕ Create button") is consistently applied across all travel booking documentation.

Files Reviewed

  • docs/articles/travel/booking-travel/Book-Rail-Travel.md: Improved clarity and terminology; minor heading hierarchy consideration noted

Overall, this is a solid documentation improvement that enhances user experience and maintains Expensify's voice and terminology standards.

@OSBotify

Copy link
Copy Markdown
Contributor

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

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

@IuliiaHerets

Copy link
Copy Markdown

Hi @stephanieelliott. Any QA steps here?

@Beamanator

Copy link
Copy Markdown
Contributor

Aah Steph i think we should add [NO QA] to the beginning of the PR title when we're only updating markdown files 🙏

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.3.5-7 🚀

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.

4 participants