Skip to content

[No QA] Add help-site search keyword aliases for cancel/per-diem/switch-to-classic - #93136

Merged
stephanieelliott merged 2 commits into
mainfrom
claude-helpSiteKeywordQuickWins
Jun 22, 2026
Merged

stephanieelliott merged 2 commits into
mainfrom
claude-helpSiteKeywordQuickWins

Conversation

@MelvinBot

@MelvinBot MelvinBot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Applies the Quick Wins (Keyword/SEO only — no new content) and Account-closure + subscription-cancel keyword/alias consolidation suggestions from the May 31, 2026 Help action items (Expensify/Expensify#643380).

These help-site search reports showed that several high-volume searches already have a matching article — the article just wasn't surfacing for the exact words users typed. This PR only edits the keywords: frontmatter so existing articles rank for those real-world search terms. No article body content was changed.

Changes:

  • Per-Diem-Expenses.md — added the one-word spelling variants perdiem, perdiems. Users searched "perdiems" (one word) and it didn't match "per diem".
  • Switch-between-New-Expensify-and-Expensify-Classic.md — added switch to classic and bare classic. The article only had "revert to Classic" / "switch back".
  • Changing-Your-Workspace-Plan.md (New Expensify billing) — added bare cancel, plus downgrade to free and per member to free to capture the "Cancel subscription from per member to free" plan-downgrade searches.
  • Change-Plan-Or-Subscription.md (Expensify Classic billing) — added cancel, unsubscribe, downgrade to free, per member to free for the same subscription-cancel consolidation.

Note on the account-closure half of the consolidation suggestion: both Close-Your-Expensify-Account.md articles (New + Classic) already include close account, cancel account, delete account, deactivate account, and terminate account, so no edits were needed there — the gap was on the subscription-cancel side, which the billing-article changes above address.

The other "Quick Wins" rows (copilot and mileage) were already present in their articles' keywords (Copilot-Access.md has copilot; Distance-Expenses.md has mileage), so no change was required.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/643380
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

N/A — static help-site markdown frontmatter change.

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 they need to test for regressions.

  • Verify that no errors appear in the JS console
Click to expand

Explanation of Change

Fixed Issues

$
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests.

  • 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 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

… per diem, and switch-to-classic

Keyword/SEO-only frontmatter updates to surface existing articles for the
terms users actually search (perdiems one-word variant, bare "cancel" and
"per member to free" for subscription downgrade, "switch to classic"). No
article body content changed.

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@MelvinBot
MelvinBot requested a review from a team June 10, 2026 02:21
@github-actions github-actions Bot changed the title Add help-site search keyword aliases for cancel/per-diem/switch-to-classic [No QA] Add help-site search keyword aliases for cancel/per-diem/switch-to-classic Jun 10, 2026
@OSBotify

This comment has been minimized.

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@MelvinBot

Copy link
Copy Markdown
Contributor Author

Fixed the failing spellcheck check.

Cause: The one-word search aliases perdiem and perdiems added to the keywords frontmatter of Per-Diem-Expenses.md aren't dictionary words, so cspell flagged them. These aliases are intentional (they catch users who search without a space), so removing them would defeat the purpose of the PR.

Fix: Added perdiem and perdiems to the word list in cspell.json (the existing diems entry confirms this is the established pattern for such terms). The other three files in the diff already passed spellcheck.

@stephanieelliott stephanieelliott added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Jun 12, 2026
@stephanieelliott
stephanieelliott marked this pull request as ready for review June 19, 2026 21:38
@stephanieelliott
stephanieelliott self-requested a review as a code owner June 19, 2026 21:38
@melvin-bot

melvin-bot Bot commented Jun 19, 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 @lydiabarclay

@melvin-bot
melvin-bot Bot requested review from lydiabarclay and suneox June 19, 2026 21:38
@melvin-bot

melvin-bot Bot commented Jun 19, 2026

Copy link
Copy Markdown

@suneox @lydiabarclay 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]

@melvin-bot
melvin-bot Bot removed the request for review from a team June 19, 2026 21:38
@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR is a keyword-only SEO/retrieval change. It edits the keywords: YAML frontmatter on four existing help articles (and adds perdiem/perdiems to cspell.json) so existing articles surface for real-world search terms pulled from help-site search reports. No article body content, headings, UI terminology, structure, or internalScope text was changed. Because the scope is limited to frontmatter keywords, the applicable governance criteria are primarily metadata/AI-retrieval alignment with real search intent (Authoring Guidelines Section 3 and Section 6).

Scores Summary

  • Readability: 10/10 - No prose, steps, or body content were changed; nothing to degrade readability. Scoped strictly to frontmatter.
  • AI Readiness: 9/10 - Added keywords (cancel, unsubscribe, downgrade to free, per member to free, switch to classic, classic, perdiem, perdiems) map directly to documented real-world queries, satisfying "Metadata must reflect real search queries" (Section 3) and "Include realistic search phrases" (Section 6). Strong, intent-driven additions.
  • Style Compliance: 10/10 - Keyword lists use the existing comma-separated bracket format. No UI labels, button/tab names, or navigation phrasing were introduced, so naming conventions are not triggered. Bare terms like classic/cancel are acceptable as search aliases (keywords are not user-facing UI references).

Key Findings

  • Positive: Every added keyword traces back to an explicit search-report row in the linked issue, so additions are evidence-based rather than speculative -- exactly the intent of the metadata rules.
  • Positive: Minimal, surgical diff (6 additions / 4 deletions). No risk to body content, headings, or structure.
  • Positive: The matching cspell.json entries (perdiem, perdiems) were added so the new one-word variants do not fail spell-check.
  • Minor: The Classic article file is Change-Plan-Or-Subscription.md but its title is "Changing Your Workspace Plan"; the PR text references it by filename. Not introduced by this PR and out of scope, but worth a future cleanup for title/filename/keyword consistency.
  • Note: Some added aliases overlap conceptually with existing keywords (e.g. cancel alongside cancel subscription, cancel plan). This is intentional for partial-match retrieval and is acceptable.

Recommendations

  • No changes required to merge from a documentation-governance standpoint.
  • Optional: Confirm there is no unintended duplication within each keyword array after the additions (none observed).
  • Optional (future, not blocking): Align the Classic article title with its filename/topic for clearer retrieval.

Files Reviewed

  • docs/articles/expensify-classic/expensify-billing/Change-Plan-Or-Subscription.md - Keywords only; added cancel, downgrade to free, per member to free, unsubscribe. Compliant.
  • docs/articles/new-expensify/billing-and-subscriptions/Changing-Your-Workspace-Plan.md - Keywords only; added cancel, downgrade to free, per member to free. Compliant.
  • docs/articles/new-expensify/reports-and-expenses/Per-Diem-Expenses.md - Keywords only; added perdiem, perdiems. Compliant.
  • docs/articles/new-expensify/settings/Switch-between-New-Expensify-and-Expensify-Classic.md - Keywords only; added switch to classic, classic. Compliant.
  • cspell.json - Added perdiem, perdiems to dictionary. Supporting change, appropriate.

Note: This is a frontmatter-only PR, so no inline line-by-line documentation comments were necessary.

@stephanieelliott
stephanieelliott removed the request for review from suneox June 20, 2026 04:17
@MelvinBot

Copy link
Copy Markdown
Contributor Author

The only failing check is PR Reviewer Checklist / checklist, which fails with No PR Reviewer Checklist was found. Every code/CI check (ESLint, Prettier, build, perf, spellcheck, Snyk, etc.) is passing. ✅

This isn't a failure I can fix by pushing to the branch — it's a process check that stays red until a reviewer completes the reviewer checklist on this PR. It will turn green once the assigned reviewer posts/fills out the PR Reviewer Checklist comment.

No code change is needed here.

@stephanieelliott
stephanieelliott merged commit ed9db21 into main Jun 22, 2026
25 of 28 checks passed
@stephanieelliott
stephanieelliott deleted the claude-helpSiteKeywordQuickWins branch June 22, 2026 18:46
@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@github-actions

Copy link
Copy Markdown
Contributor

🚧 @stephanieelliott has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

Copy link
Copy Markdown
Contributor

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

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

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/blimpich in version: 9.4.17-3 🚀

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

1 similar comment
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/blimpich in version: 9.4.17-3 🚀

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

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.

4 participants