Skip to content

[No QA] Add high-volume search keywords to help-site articles (quick wins) - #92461

Merged
VictoriaExpensify merged 3 commits into
mainfrom
claude-helpSiteKeywordQuickWins
Jun 9, 2026
Merged

[No QA] Add high-volume search keywords to help-site articles (quick wins)#92461
VictoriaExpensify merged 3 commits into
mainfrom
claude-helpSiteKeywordQuickWins

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Help-site SEO "quick wins" from the May 24 action items (Expensify/Expensify#640367). These are keyword-only edits to existing article frontmatter (no content changes) to surface existing articles for high-volume search terms the search-log analysis flagged.

What changed (the genuine gaps):

Search term Article Change
"cancel subscription" / "cancel" expensify-classic/expensify-billing/Change-Plan-Or-Subscription.md This Classic article had only [Expensify Classic, workspace plan, subscription] — added cancel subscription, cancel plan, change plan, change subscription, downgrade subscription, downgrade plan
"mileage" new-expensify/reports-and-expenses/Distance-Expenses.md Added the bare mileage term (only compound variants like "mileage reimbursement" existed)
"webinar" new-expensify/getting-started/How-to-Access-Expensify-Training.md Added webinar and register for webinar (only "live webinar" existed)

Already covered — no change needed: While preparing this PR I checked the other three quick-win terms against the current frontmatter and found they're already present, so I deliberately left them alone to avoid redundant keyword padding:

  • "delete account" — already a keyword in both the New Expensify and Classic Close-Your-Expensify-Account.md
  • "2FA" — already a keyword in both Two-Factor-Authentication.md articles
  • "copilot" (singular) — already a keyword in new-expensify/settings/Copilot-Access.md and the Classic Copilot article

The New Expensify docs appear to have had a recent metadata pass that already added rich keyword coverage, so the remaining gaps were narrower than the original 6-item list.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/640367
PROPOSAL:

Tests

This is a docs-only change (help-site markdown frontmatter). No app behavior changes.

// TODO: The human co-author must fill out the tests you ran before marking this PR as "ready for review".

  • Verify the three articles still render on the help site after the help-site deploy
  • Verify a help-site search for "cancel subscription", "mileage", and "webinar" surfaces the corresponding article

Offline tests

N/A — help-site content change.

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 followed proper code patterns (see Reviewing the code)
  • 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

N/A — docs-only keyword frontmatter change.

Improves discoverability for the "quick wins" identified in the May 24
help-site action items: surfaces the Classic plan/subscription article
for "cancel subscription" searches, and adds the exact "mileage" and
"webinar" search terms to the Distance Expenses and Training articles.

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@MelvinBot
MelvinBot requested a review from a team June 3, 2026 02:34
@github-actions github-actions Bot changed the title Add high-volume search keywords to help-site articles (quick wins) [No QA] Add high-volume search keywords to help-site articles (quick wins) Jun 3, 2026
@OSBotify

This comment has been minimized.

@stephanieelliott
stephanieelliott marked this pull request as ready for review June 6, 2026 01:47
@stephanieelliott
stephanieelliott self-requested a review as a code owner June 6, 2026 01:47
@melvin-bot

melvin-bot Bot commented Jun 6, 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 @VictoriaExpensify

@melvin-bot
melvin-bot Bot requested a review from VictoriaExpensify June 6, 2026 01:47
@melvin-bot

melvin-bot Bot commented Jun 6, 2026

Copy link
Copy Markdown

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

@melvin-bot
melvin-bot Bot removed the request for review from a team June 6, 2026 01:47
Comment thread docs/articles/new-expensify/getting-started/How-to-Access-Expensify-Training.md Outdated
@github-actions

github-actions Bot commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR makes targeted, keyword-only edits to the YAML frontmatter of three help-site articles. The goal is to close gaps identified in search-log analysis by adding high-volume search terms (e.g., "cancel subscription", "mileage", "webinar") that were previously missing or only present in compound form. No article content was changed. The changes are well-scoped, clearly justified in the PR description, and align with SEO/retrieval best practices.

Scores Summary

  • Readability: 10/10 - No prose or content was modified; the keyword additions are clean and well-formatted within their respective frontmatter blocks.
  • AI Readiness: 9/10 - The added keywords are realistic search phrases that directly improve semantic retrieval. One minor observation: Change-Plan-Or-Subscription.md still lacks an internalScope field (required per HELP_AUTHORING_GUIDELINES.md Section 3 and TEMPLATE.md), though this is a pre-existing gap not introduced by this PR. Additionally, How-to-Access-Expensify-Training.md uses bare comma-separated keyword format rather than the bracket array syntax shown in TEMPLATE.md -- also pre-existing and not introduced here.
  • Style Compliance: 10/10 - All added keywords use consistent terminology aligned with Expensify UI language and naming conventions. No prohibited language or style violations are present in the changed lines.

Key Findings

  • The keyword additions are well-chosen: they fill genuine gaps between what users search for and what was indexed, without introducing redundant or off-topic terms.
  • The PR author demonstrated good judgment by auditing the other three candidate terms ("delete account", "2FA", "copilot") and confirming they were already covered, avoiding keyword padding.
  • Pre-existing issues (missing internalScope on the Classic article, bare keyword format on the training article) are outside the scope of this PR but worth tracking for a future metadata cleanup pass.

Recommendations

  • No blocking issues. The proposed changes are clean and appropriate.
  • Future consideration: A follow-up pass on Change-Plan-Or-Subscription.md to add internalScope would bring it into full compliance with the metadata spec.
  • Future consideration: Normalizing the keyword format in How-to-Access-Expensify-Training.md to use bracket array syntax (keywords: [...]) would match the TEMPLATE.md standard.

Files Reviewed

  • docs/articles/expensify-classic/expensify-billing/Change-Plan-Or-Subscription.md -- Keywords expanded with cancel/change/downgrade variants. Clean and well-targeted.
  • docs/articles/new-expensify/getting-started/How-to-Access-Expensify-Training.md -- Added "webinar" and "register for webinar" as standalone terms. Good gap fill.
  • docs/articles/new-expensify/reports-and-expenses/Distance-Expenses.md -- Added bare "mileage" keyword alongside existing compound variants. Sensible addition.

Note: This PR contains no content changes, only YAML frontmatter keyword edits. No inline comments were necessary.

…nsify-Training.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@OSBotify

This comment has been minimized.

@stephanieelliott stephanieelliott added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Jun 6, 2026
@OSBotify

OSBotify commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

@stephanieelliott

Copy link
Copy Markdown
Contributor

Bump @VictoriaExpensify, can you review plz?

@VictoriaExpensify

VictoriaExpensify commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (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
    • 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 verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • 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
  • 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
    • 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(theme.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 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

@VictoriaExpensify
VictoriaExpensify merged commit d1528a5 into main Jun 9, 2026
19 checks passed
@VictoriaExpensify
VictoriaExpensify deleted the claude-helpSiteKeywordQuickWins branch June 9, 2026 04:38
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/VictoriaExpensify in version: 9.4.2-0 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/VictoriaExpensify in version: 9.4.4-1 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.4.4-3 🚀

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

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