Skip to content

[No QA] Docs updates for E/A#99516 Book travel now available from Search - #100223

Merged
CortneyOfstad merged 3 commits into
mainfrom
melvin-docsBookTravelSearchSuggestion
Sep 29, 2026
Merged

CortneyOfstad merged 3 commits into
mainfrom
melvin-docsBookTravelSearchSuggestion

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Help site follow-up for #99516, which surfaces Book travel in the Search Router's Create suggestions. Before that PR, Book travel could only be started from the ➕ Create button, and that is the only entry point the help site documents.

Changes:

  1. docs/articles/new-expensify/getting-started/Navigating-New-Expensify.md — this article already documents jumping to a destination from Search, but not starting an action from it. Added a ## How to start an action using Search section, two FAQ entries (Can I book travel from Search? and Why don't I see Book travel in Search?), and updated keywords / internalScope.
  2. The six articles in docs/articles/travel/booking-travel/ — each carries the same ## Where to find Expensify Travel block. Added one sentence to each giving Search as a second entry point, plus the eligibility rule.

Behavior documented, taken from the code in #99516:

  • Selecting Book travel from Search opens the same booking tool as the ➕ Create button item (TravelDot when the account and workspace are ready, otherwise the existing Travel / My Trips flow).
  • Book travel only appears when Expensify Travel is enabled on the active workspace — having it enabled on some other workspace is not enough. This rule already applied to the ➕ Create button item, but was not documented.

Scope note for the reviewer: the same one-line "where to find Expensify Travel" boilerplate also appears in roughly 25 other travel articles (travel policy, company setup, managing trips, and analytics). I limited this PR to the booking articles, where the reader is actively trying to open the booking tool, to keep the diff reviewable. Say the word and I'll roll the same sentence out to the rest.

Written against docs/HELPSITE_NAMING_CONVENTIONS.md, docs/HELP_AUTHORING_GUIDELINES.md, and docs/TEMPLATE.md. UI labels were verified against dev NewDot on web: the entry point's accessible name is exactly Search (magnifying glass icon), and the action rows read Create expense, Create report, Track distance, Start chat, and New workspace. Book travel could not be observed directly because the test account has no Travel-enabled workspace — which matches the eligibility rule above — so its label is taken from travel.bookTravel in src/languages/en.ts (Book travel), the same string the ➕ Create button item uses.

Fixed Issues

$ #92752
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

Not applicable — this PR only changes help site markdown under docs/articles.

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

AI Tests

Docs-only change (7 markdown files under docs/articles), so no app test bundle applies. cspell and npm run spell-changed could not be run in this environment — no new or unusual vocabulary was introduced, but CI's spell check is the authoritative gate.

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

@nabi-ebrahimi, 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: Nabi <nabi-ebrahimi@users.noreply.github.com>
@MelvinBot
MelvinBot requested a review from a team September 2, 2026 21:31
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Sep 2, 2026
@github-actions github-actions Bot changed the title Docs updates for E/A#99516 Book travel now available from Search [No QA] Docs updates for E/A#99516 Book travel now available from Search Sep 2, 2026
@OSBotify

This comment has been minimized.

@stephanieelliott stephanieelliott self-assigned this Sep 5, 2026
@nabi-ebrahimi

Copy link
Copy Markdown
Contributor

I reviewed the documentation changes and confirmed they match the implemented behavior in #99516.

@MelvinBot mark this PR as ready for review

@stephanieelliott
stephanieelliott marked this pull request as ready for review September 23, 2026 04:43
@melvin-bot

melvin-bot Bot commented Sep 23, 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 @CortneyOfstad

@melvin-bot
melvin-bot Bot requested review from CortneyOfstad and marufsharifi and removed request for a team September 23, 2026 04:43
@melvin-bot

melvin-bot Bot commented Sep 23, 2026

Copy link
Copy Markdown

@marufsharifi @CortneyOfstad 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]

Comment thread docs/articles/travel/booking-travel/Book-Rail-Travel.md
Comment thread docs/articles/travel/booking-travel/Book-a-Hotel.md
Comment thread docs/articles/travel/booking-travel/Book-a-Rental-Car.md
Comment thread docs/articles/travel/booking-travel/Book-Travel-for-a-Guest.md
@@ -13,6 +13,8 @@ Book flights easily with Expensify Travel. This guide walks you through finding

Tap the **➕ Create** button at the bottom of your screen, then choose **Book 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.

Cross-platform / deterministic consistency: The preceding step uses "Tap the ➕ Create button at the bottom of your screen" (mobile phrasing), but this added sentence uses "select Search" with the desktop-oriented "(the magnifying glass icon)". Keep the interaction verb consistent and state the platform explicitly per the Cross-Platform Clarity and Deterministic Writing rules.

@github-actions

github-actions Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR documents a new entry point: Book travel (and other actions) can now be started from Search, following #99516. It adds a task section plus two FAQ entries to Navigating-New-Expensify.md, and appends a single consistent sentence to the "Where to find Expensify Travel" block in six booking articles. The writing is clear, uses UI-exact labels, and the eligibility rule (active workspace) is stated consistently. A few structural and metadata items should be tightened before merge.

Scores Summary

  • Readability: 9/10 - Sentences are clear and scannable, steps are sequential and action-oriented, and the repeated travel-article sentence reads well in context.
  • AI Readiness: 6/10 - New headings are task-based and full feature names are used, but the frontmatter keywords/internalScope in Navigating-New-Expensify.md were not updated to reflect the new "start an action" / "Book travel from Search" workflow, despite the PR description stating they were.
  • Style Compliance: 8/10 - UI labels (Search, the ➕ Create button, Book travel), terminology (Workspace Admin, workspace), and FAQ question phrasing follow the naming conventions. Minor: a missing --- separator after the new section, and the new FAQ answers repeat full step instructions rather than staying concise.

Key Findings

  • Missing frontmatter update: the added Search-action workflow and Book travel content are not reflected in keywords or internalScope of Navigating-New-Expensify.md. The PR description claims these were updated, but the diff shows no frontmatter change. This hurts retrieval for the new content.
  • Structural nit: in Navigating-New-Expensify.md the new ## How to start an action using Search section runs directly into the following ## How to jump to a domain page using Search with no --- separator, unlike the surrounding sections which are consistently separated.
  • Consistency win: the same one-sentence Search entry point plus eligibility rule is applied identically across all six booking articles - good for retrieval and maintenance.
  • Correct conventions: Book travel, Search (with the magnifying glass icon described), and the ➕ Create button are used exactly and bolded per the naming conventions. Cross-links use descriptive anchor text.
  • Minor inconsistency: the travel articles link to Enable-Travel with a full https://help.expensify.com/... URL (pre-existing in those files), while the guidelines require relative links. The new Navigating content correctly uses a relative link.

Recommendations

  • Update keywords and internalScope in Navigating-New-Expensify.md to include the Search-action workflow and Book travel (e.g. "book travel from Search", "start an action from Search").
  • Add a --- separator after the new ## How to start an action using Search section to match the article's structure.
  • Consider trimming the two new FAQ answers so they summarize rather than fully restate the step sequence already in the body.
  • Optional: when convenient, migrate the travel articles' Enable-Travel links to relative form to match the guidelines.

Files Reviewed

  • docs/articles/new-expensify/getting-started/Navigating-New-Expensify.md - New task section + 2 FAQ entries; strong content, needs frontmatter + separator fixes.
  • docs/articles/travel/booking-travel/Arrange-Travel-for-Another-User.md - One-sentence Search entry point added; compliant.
  • docs/articles/travel/booking-travel/Book-Rail-Travel.md - Same addition; compliant.
  • docs/articles/travel/booking-travel/Book-Travel-for-a-Guest.md - Same addition; compliant.
  • docs/articles/travel/booking-travel/Book-a-Flight.md - Same addition; compliant.
  • docs/articles/travel/booking-travel/Book-a-Hotel.md - Same addition; compliant.
  • docs/articles/travel/booking-travel/Book-a-Rental-Car.md - Same addition; compliant.

Note: Detailed line-by-line feedback has been provided as inline comments.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c4469955f7

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@OSBotify

This comment has been minimized.

@stephanieelliott
stephanieelliott removed the request for review from marufsharifi September 25, 2026 00:41
paulnjs pushed a commit to paulnjs/paulnjs-expensify-app that referenced this pull request Sep 25, 2026
@CortneyOfstad
CortneyOfstad merged commit 0b01b13 into main Sep 29, 2026
24 of 25 checks passed
@CortneyOfstad
CortneyOfstad deleted the melvin-docsBookTravelSearchSuggestion branch September 29, 2026 20:56
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.

5 participants