Skip to content

Conversation

@strepanier03
Copy link
Contributor

@strepanier03 strepanier03 commented Jan 27, 2026

COMING FROM: https://github.com/Expensify/Expensify/issues/593624

Updating travel docs - per https://docs.google.com/spreadsheets/d/1dK3yLYzw7Xa6SXyF4DNj4QJOiNS-ty9xDb3uqsexfuE/edit?usp=sharing

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

@strepanier03 strepanier03 self-assigned this Jan 27, 2026
@strepanier03 strepanier03 changed the title Update Configuring-Flight-Settings.md [WIP] Update Configuring-Flight-Settings.md Jan 27, 2026
@github-actions github-actions bot changed the title [WIP] Update Configuring-Flight-Settings.md [No QA] [WIP] Update Configuring-Flight-Settings.md Jan 27, 2026
@OSBotify
Copy link
Contributor

OSBotify commented Jan 27, 2026

@strepanier03 strepanier03 changed the title [No QA] [WIP] Update Configuring-Flight-Settings.md [No QA] [WIP] Update Travel help docs for multiple changes Jan 27, 2026
@strepanier03
Copy link
Contributor Author

strepanier03 commented Jan 27, 2026

Updated access instructions
Updating access instructions.
Updating access instructions.
Copy link
Contributor Author

@strepanier03 strepanier03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Figured I'd update the access instructions after our chat in Slack here - https://expensify.slack.com/archives/C02QSAC6BJ8/p1769024505847459

@strepanier03
Copy link
Contributor Author

I'll review the builds again with the updated access instructions but my last review of my more important changes was good.

Noticed some odd formatting issues, trying to correct.
Figured out the formatting issue, fixed it with this change.
@strepanier03
Copy link
Contributor Author

One last change, figured out the Hotel settings doc formatting issues. Will review fresh build before setting for review.

@strepanier03 strepanier03 changed the title [No QA] [WIP] Update Travel help docs for multiple changes [No QA] Update Travel help docs for multiple changes Jan 28, 2026
@strepanier03 strepanier03 marked this pull request as ready for review January 28, 2026 00:09
@github-actions
Copy link
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates three Travel help documentation files with significant improvements to structure, new feature documentation, and standardized access instructions. The changes add valuable content about report scheduling, property type restrictions, and enhanced flight/hotel policy settings. Overall quality is strong, though there are some inconsistencies in formatting and style that should be addressed.

Scores Summary

  • Readability: 8/10 - Clear, well-organized content with logical flow. Minor issues with inconsistent formatting (some sections use bold subheadings within sections, others use proper heading levels) and a few overly technical explanations that could be simplified.
  • AI Readiness: 7/10 - Good descriptive headings and YAML metadata. However, inconsistent heading hierarchy (mixing bold text with actual headings) and some sections lack clear context for standalone understanding. The "Nightly median rate" section particularly needs clarification.
  • Style Compliance: 8/10 - Generally follows Expensify conventions with proper terminology (workspace, Workspace Admin). The standardized access section is excellent. Minor issues: inconsistent capitalization in UI elements and some sections reference "customers" instead of using direct address ("you").

Key Findings

Positive Aspects:

  • Excellent standardization of the "Where to find Expensify Travel" section across all three files
  • New features (Favorites, Scheduling Reports, Property Type restrictions) are well-documented
  • YAML metadata is complete and descriptive with relevant keywords
  • Good use of examples (e.g., keyword matching in flight settings)
  • FAQ sections address practical user questions

Issues Identified:

  • Formatting inconsistency: Overview-of-Analytics.md uses proper ## headings for new sections (Favorites, Scheduling Reports), while Configuring-Hotel-Settings.md mixes bold text and headings for policy settings
  • Style issues: References to "customers" (e.g., "Customers can click + Add Restriction") should use second-person "you" instead
  • Clarity concerns: The "Nightly median rate" feature description states it's "informational only" but doesn't clearly explain how travelers should use this information
  • Missing context: Some technical terms like "Tier exception" and "Supplier Management" assume prior knowledge

Recommendations

Priority Actions:

  1. Fix heading hierarchy in Configuring-Hotel-Settings.md - Convert all bold section titles (lines 31-73) to proper ## heading levels for consistency and AI parsing
  2. Remove "customers" references - Replace with direct second-person address throughout ("You can click..." or imperative "Click...")
  3. Clarify the Nightly median rate feature - Add a sentence explaining practical use: "Use this benchmark to evaluate whether your selected hotel represents good value"

Suggestions for Improvement:

  1. Consider adding a brief introductory sentence to the "Property type" section explaining why restricting by type matters
  2. The "Add Block fares with airport transfers" section is very brief - consider adding an example or use case
  3. Ensure consistent terminology: "click" vs "tap" (standardize based on platform context)

Files Reviewed

  • docs/articles/travel/travel-analytics/Overview-of-Analytics.md - Good additions with proper heading structure and comprehensive feature documentation
  • docs/articles/travel/travel-policy/Configuring-Flight-Settings.md - Clear updates with helpful examples; minor style issues with "customers" language
  • docs/articles/travel/travel-policy/Configuring-Hotel-Settings.md - Needs heading hierarchy fixes; otherwise strong content with good detail

Note: The core content quality is high and these updates will significantly improve the Travel documentation. The recommended changes are primarily formatting and style refinements.

Copy link
Contributor Author

@strepanier03 strepanier03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actioned all the suggestions by the GH bot that I agreed with and that made sense. Ready for you @stephanieelliott

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