Skip to content

[No QA] Add search keyword synonyms for help site discoverability#91789

Open
MelvinBot wants to merge 1 commit into
mainfrom
claude-searchKeywordSynonyms
Open

[No QA] Add search keyword synonyms for help site discoverability#91789
MelvinBot wants to merge 1 commit into
mainfrom
claude-searchKeywordSynonyms

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Summary

  • Adds keyword synonyms to the keywords frontmatter array across 15 help articles (both New Expensify and Expensify Classic) to improve search discoverability
  • Covers password/login, account closure, receipt forwarding, subscription/billing, distance/mileage, CSV/import, per diem, eReceipts, and two-factor authentication topics
  • Addresses the 75% query uniqueness ratio observed in help site search data by ensuring common rephrasings match the correct articles

Related: Expensify/Expensify#637958

Test plan

  • Verify the help site builds successfully with the updated frontmatter
  • Search for synonym terms (e.g., "forgot password", "delete account", "csv import", "mileage", "2FA") on the help site and confirm they return the expected articles
  • Confirm no article content was changed -- only keywords arrays in frontmatter

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@github-actions github-actions Bot changed the title Add search keyword synonyms for help site discoverability [No QA] Add search keyword synonyms for help site discoverability May 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds keyword synonyms to the keywords frontmatter array across 15 help articles (both New Expensify and Expensify Classic). The changes are metadata-only -- no article body content was modified. The goal is to improve search discoverability by adding common rephrasings and synonyms that users actually type when searching for help. This is a well-scoped, low-risk improvement.

Scores Summary

  • Readability: 9/10 - No article body content was changed, so readability is unaffected. The keywords themselves are clear and well-phrased, using natural language that matches real search queries.
  • AI Readiness: 9/10 - The added keywords directly improve semantic retrieval by covering synonyms and alternate phrasings (e.g., "MFA" for 2FA, "forgot password" for login troubleshooting, "csv import" for spreadsheet import). This aligns well with Section 6 of HELP_AUTHORING_GUIDELINES.md which requires realistic search phrases. One minor gap noted below.
  • Style Compliance: 9/10 - Keywords use appropriate terminology consistent with HELPSITE_NAMING_CONVENTIONS.md. Minor issues noted below.

Key Findings

Positive aspects:

  • Keyword additions are thoughtful and clearly data-driven (PR description references 75% query uniqueness ratio from search data)
  • Good coverage of common synonyms: "MFA" / "multi-factor authentication" for 2FA articles, "forgot password" / "reset password" for login troubleshooting, "mileage" / "miles" / "kilometers" for distance expenses
  • Consistent approach across both New Expensify and Expensify Classic articles
  • Changes are purely additive to the keywords array -- no risk of breaking existing content

Minor issues:

  • Close-Your-Expensify-Account.md (New Expensify) adds "close account" as a keyword, but "close account" already exists in the original keywords array. This is a duplicate that should be removed.
  • Per-Diem-Expenses.md does not have an internalScope field in its frontmatter. Per Section 3 of HELP_AUTHORING_GUIDELINES.md, this is a required metadata field. While this is pre-existing (not introduced by this PR), it is worth flagging since the file is being touched.
  • Change-Plan-Or-Subscription.md (Expensify Classic) also lacks an internalScope field -- same note as above.

Recommendations

  1. Remove the duplicate keyword "close account" from docs/articles/new-expensify/settings/Close-Your-Expensify-Account.md -- it appears twice in the updated keywords array.
  2. Consider adding internalScope to the two files that are missing it (Per-Diem-Expenses.md and Change-Plan-Or-Subscription.md) since these files are already being modified. This would bring them into full compliance with the authoring guidelines.
  3. No other blocking issues -- this PR is ready to merge after addressing the duplicate keyword.

Files Reviewed

  • docs/articles/expensify-classic/expenses/Add-an-expense.md - Keywords expanded with receipt forwarding synonyms. Looks good.
  • docs/articles/expensify-classic/expensify-billing/Change-Plan-Or-Subscription.md - Keywords expanded with cancellation synonyms. Looks good. Missing internalScope (pre-existing).
  • docs/articles/expensify-classic/settings/Close-Your-Expensify-Account.md - Keywords expanded with account closure synonyms. Looks good.
  • docs/articles/expensify-classic/settings/Two-Factor-Authentication.md - Keywords expanded with MFA/security synonyms. Looks good.
  • docs/articles/new-expensify/billing-and-subscriptions/Changing-Your-Workspace-Plan.md - Keywords expanded with cancellation synonyms. Looks good.
  • docs/articles/new-expensify/connect-credit-cards/Configure-Company-Card-Settings.md - Keywords expanded with eReceipt synonyms. Looks good.
  • docs/articles/new-expensify/connect-credit-cards/Import-Company-Card-Transactions-From-a-Spreadsheet.md - Keywords expanded with CSV/import synonyms. Looks good.
  • docs/articles/new-expensify/connect-credit-cards/Import-Personal-Card-Transactions-From-a-Spreadsheet.md - Keywords expanded with CSV/import synonyms. Looks good.
  • docs/articles/new-expensify/reports-and-expenses/Attach-and-edit-receipts-on-expenses.md - Keywords expanded with eReceipt synonyms. Looks good.
  • docs/articles/new-expensify/reports-and-expenses/Create-an-Expense.md - Keywords expanded with receipt forwarding synonyms. Looks good.
  • docs/articles/new-expensify/reports-and-expenses/Distance-Expenses.md - Keywords expanded with mileage unit synonyms. Looks good.
  • docs/articles/new-expensify/reports-and-expenses/Per-Diem-Expenses.md - Keywords expanded with rate synonyms. Looks good. Missing internalScope (pre-existing).
  • docs/articles/new-expensify/settings/Close-Your-Expensify-Account.md - Keywords expanded but contains duplicate "close account". Needs fix.
  • docs/articles/new-expensify/settings/Login-Troubleshooting.md - Keywords expanded with password-related synonyms. Looks good.
  • docs/articles/new-expensify/settings/Two-Factor-Authentication.md - Keywords expanded with MFA/security synonyms. Looks good.

Note: This PR contains metadata-only changes (keywords), so inline comments were not necessary. All feedback is captured in this summary.

title: Close Your Expensify Account
description: Learn how to close your Expensify account.
keywords: [New Expensify, close account, delete Expensify account, delete account, remove user, deactivate account, cancel account, cancel Expensify, terminate, how to delete Expensify, how to cancel Expensify]
keywords: [New Expensify, close account, delete Expensify account, delete account, remove user, deactivate account, cancel account, cancel Expensify, terminate, how to delete Expensify, how to cancel Expensify, remove account, close account, terminate account, delete Expensify, how to delete, how to cancel]
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.

Duplicate keyword: close account appears twice in this keywords array (positions 2 and 13). Remove the duplicate to keep metadata clean.

title: Close Your Expensify Account
description: Learn how to close your Expensify account.
keywords: [Expensify Classic, close account, delete account, cancel account, delete Expensify account, cancel Expensify, deactivate account, how to delete Expensify, how to cancel Expensify]
keywords: [Expensify Classic, close account, delete account, cancel account, delete Expensify account, cancel Expensify, deactivate account, how to delete Expensify, how to cancel Expensify, remove account, terminate account, delete Expensify, how to delete, how to cancel, remove user]
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: Per HELPSITE_NAMING_CONVENTIONS.md, use "member" instead of "user." The keyword remove user should be remove member.

title: Close Your Expensify Account
description: Learn how to close your Expensify account.
keywords: [New Expensify, close account, delete Expensify account, delete account, remove user, deactivate account, cancel account, cancel Expensify, terminate, how to delete Expensify, how to cancel Expensify]
keywords: [New Expensify, close account, delete Expensify account, delete account, remove user, deactivate account, cancel account, cancel Expensify, terminate, how to delete Expensify, how to cancel Expensify, remove account, close account, terminate account, delete Expensify, how to delete, how to cancel]
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: Per HELPSITE_NAMING_CONVENTIONS.md, use "member" instead of "user." The keyword remove user should be remove member.

title: Create an Expense
description: Learn how to create and submit expenses in Expensify using SmartScan, manual entry, distance tracking, or time expenses.
keywords: [create expense, submit expense, SmartScan, manual expense, distance expense, time expense, create time expense, log time, track hours, expense report, submit to workspace, submit to individual, split expense, scan receipts, bulk upload, GPS, GPS tracking, GPS mileage, Proofpoint, email forwarding, receipt forwarding]
keywords: [create expense, submit expense, SmartScan, manual expense, distance expense, time expense, create time expense, log time, track hours, expense report, submit to workspace, submit to individual, split expense, scan receipts, bulk upload, GPS, GPS tracking, GPS mileage, Proofpoint, email forwarding, receipt forwarding, email receipt, forward receipt, forward email receipt, email receipts@expensify.com, scan receipt, receipt email]
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 / metadata consistency: This keywords array is missing New Expensify as the first keyword. All other New Expensify articles include it (e.g., [New Expensify, create expense, ...]). Adding it improves retrieval accuracy and matches the pattern across the help site.

Copy link
Copy Markdown

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

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: 49e9ae5131

ℹ️ 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".

title: Close Your Expensify Account
description: Learn how to close your Expensify account.
keywords: [Expensify Classic, close account, delete account, cancel account, delete Expensify account, cancel Expensify, deactivate account, how to delete Expensify, how to cancel Expensify]
keywords: [Expensify Classic, close account, delete account, cancel account, delete Expensify account, cancel Expensify, deactivate account, how to delete Expensify, how to cancel Expensify, remove account, terminate account, delete Expensify, how to delete, how to cancel, remove user]
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove misleading remove-user keyword

When a Classic workspace admin searches for “remove user”, this keyword now makes the account-closure article match even though the article’s own scope says it does not cover removing members from a domain/workspace, and the Classic workspace member-removal flow lives in docs/articles/expensify-classic/workspaces/Remove-Members.md. This will steer member-offboarding searches toward instructions for permanently closing an individual account instead of removing a workspace member.

Useful? React with 👍 / 👎.

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