Skip to content

[No QA] [NO QA] Docs updates for E/A#84510 rename cancel subscription option in help articles#88925

Merged
johncschuster merged 5 commits into
mainfrom
melvin-docs-cancel-subscription-84510
May 13, 2026
Merged

[No QA] [NO QA] Docs updates for E/A#84510 rename cancel subscription option in help articles#88925
johncschuster merged 5 commits into
mainfrom
melvin-docs-cancel-subscription-84510

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Summary

  • Updates help site articles to reflect the UI rename from Request early cancellation to Cancel subscription introduced in feat: Make Cancel Subscription Option More Visible and Accessible #84510
  • Updated articles:
    • docs/articles/new-expensify/billing-and-subscriptions/Add-a-payment-card-and-view-your-subscription.md
    • docs/articles/new-expensify/billing-and-subscriptions/Changing-Your-Workspace-Plan.md

Test plan

  • Verify all references to "Request early cancellation" have been replaced with "Cancel subscription"
  • Verify the updated instructions match the new UI flow
  • Confirm no broken markdown formatting

…ption

Reflects the UI changes from #84510 which renamed the
subscription cancellation feature from "Request early cancellation" to
"Cancel subscription" across the app.

Co-authored-by: TaduJR <TaduJR@users.noreply.github.com>
@github-actions github-actions Bot changed the title [NO QA] Docs updates for E/A#84510 rename cancel subscription option in help articles [No QA] [NO QA] Docs updates for E/A#84510 rename cancel subscription option in help articles Apr 27, 2026
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 27, 2026

@MelvinBot MelvinBot changed the title [No QA] [NO QA] Docs updates for E/A#84510 rename cancel subscription option in help articles [NO QA] Docs updates for E/A#84510 rename cancel subscription option in help articles Apr 28, 2026
@stephanieelliott stephanieelliott added the HelpDot Apply this label if the issue relates to ExpensifyHelp label May 6, 2026
@stephanieelliott stephanieelliott self-assigned this May 6, 2026
@github-actions github-actions Bot changed the title [NO QA] Docs updates for E/A#84510 rename cancel subscription option in help articles [No QA] [NO QA] Docs updates for E/A#84510 rename cancel subscription option in help articles May 9, 2026
@stephanieelliott stephanieelliott marked this pull request as ready for review May 9, 2026 03:22
@stephanieelliott stephanieelliott self-requested a review as a code owner May 9, 2026 03:22
@stephanieelliott stephanieelliott requested a review from a team May 9, 2026 03:22
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 9, 2026

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 @johncschuster

@melvin-bot melvin-bot Bot requested review from johncschuster and removed request for a team May 9, 2026 03:22
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 9, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

HelpDot Documentation Review

Overall Assessment

This PR updates two help site articles to reflect a UI rename from "Request early cancellation" to "Cancel subscription." The changes are well-scoped and correctly align documentation with the updated product UI. There is one grammatical error that should be fixed before merge, and one minor formatting inconsistency worth addressing.

Scores Summary

  • Readability: 8/10 - The consolidated intro paragraph in the first file is an improvement. One grammatical error ("requesting to canceling") undermines clarity in an otherwise clean set of changes.
  • AI Readiness: 9/10 - Metadata (title, description, keywords, internalScope) is properly updated to reflect new terminology. Headings remain task-based and searchable. The renamed heading "How to request to cancel an annual subscription" includes the feature name and starts with an action word.
  • Style Compliance: 8/10 - Button references correctly use bold formatting (**Cancel subscription**). However, the new intro paragraph references "Account > Subscription" without bold formatting, while the rest of the article consistently uses **Account > Subscription**. The governance files require bold for UI element references.

Key Findings

Must fix:

  • Grammatical error in Add-a-payment-card-and-view-your-subscription.md: The phrase "requesting to canceling your subscription" (under "What to do if you can't update a subscription") is incorrect. It should read "requesting to cancel your subscription" or "canceling your subscription."

Should fix:

  • Missing bold on navigation path: The new intro paragraph says Account > Subscription without bold formatting. Per HELPSITE_NAMING_CONVENTIONS.md, UI elements must be bolded. Later in the same file, **Account > Subscription** is correctly bolded, creating an inconsistency.

Positive aspects:

  • Terminology updates are applied consistently across both files.
  • The button name **Cancel subscription** is correctly bolded in all step instructions.
  • The consolidated intro paragraph in the first file is more concise and scannable than the two-line version it replaces.
  • The removal of the redundant billing-owner note avoids duplicating information already stated in the "Who can manage" section.
  • The second file (Changing-Your-Workspace-Plan.md) changes are clean with no issues.

Pre-existing observation (not part of this PR's scope):

  • The first file uses multiple # headings for content sections, which does not conform to HELP_AUTHORING_GUIDELINES.md (only one # title plus optional # FAQ). This is not introduced by this PR and is outside its scope, but is worth noting for a future cleanup pass.

Recommendations

  1. Fix the grammatical error: Change "requesting to canceling your subscription" to "requesting to cancel your subscription."
  2. Bold the navigation path: Change Account > Subscription to **Account > Subscription** in the intro paragraph.
  3. Both fixes are minor and this PR is otherwise ready to merge after addressing them.

Files Reviewed

  • docs/articles/new-expensify/billing-and-subscriptions/Add-a-payment-card-and-view-your-subscription.md -- Terminology updated correctly; one grammar error and one missing bold need fixing.
  • docs/articles/new-expensify/billing-and-subscriptions/Changing-Your-Workspace-Plan.md -- Clean, no issues found.

Review based on governance files: HELPSITE_NAMING_CONVENTIONS.md, HELP_AUTHORING_GUIDELINES.md, and TEMPLATE.md.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@stephanieelliott
Copy link
Copy Markdown
Contributor

Addressed all bot comments!

@johncschuster johncschuster merged commit 053707d into main May 13, 2026
17 checks passed
@johncschuster johncschuster deleted the melvin-docs-cancel-subscription-84510 branch May 13, 2026 15:10
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 13, 2026

@johncschuster looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot Bot added the Emergency label May 13, 2026

# How to request to cancel an annual subscription
## How to request to cancel an annual subscription
1. Go to **Account > Subscription**.
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.

Structure violation: This ## heading is an exact duplicate of the # heading on the line above it. Remove this duplicate line — having both # How to request to cancel an annual subscription and ## How to request to cancel an annual subscription back-to-back is redundant and breaks the heading hierarchy.

# How to request early cancellation of an annual subscription

# How to request to cancel an annual subscription
## How to request to cancel an annual subscription
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.

Structure violation (HELP_AUTHORING_GUIDELINES Section 4): Per the authoring guidelines, articles must have "Exactly one # heading (the article title). No other # headings are allowed except # FAQ." This # heading should be changed to ## since the article title is already on line 2 (in the YAML title field). This applies to the other # headings in the article as well, though those are outside the scope of this PR's changes.

Comment on lines +116 to 117
If you're blocked from updating billing settings, requesting to cancel your subscription, or deleting a workspace, it's likely because you're not the billing owner.
If you are a Workspace Admin, you can transfer billing ownership to yourself by following the steps to [transfer billing ownership](LINK).
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.

Readability / duplicate content: These two lines are near-duplicates of each other. Line 116 also contains a grammar error ("requesting to canceling" should be "requesting to cancel"). Remove line 116 entirely and keep only line 117, which has the correct phrasing.

@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates subscription cancellation terminology across two billing-related articles, replacing "early cancellation" language with "Cancel subscription" to align with current UI button text. The intent is sound, but the first file introduces two copy-paste defects that must be fixed before merging.

Scores Summary

  • Readability: 6/10 - The terminology updates improve clarity, but two defects in Add-a-payment-card-and-view-your-subscription.md hurt readability: a duplicated paragraph (one copy containing a grammatical error) and a duplicated heading at two different levels.
  • AI Readiness: 7/10 - YAML metadata is present and well-formed with internalScope. Headings are task-based and include feature names. The duplicate heading (# and ## with identical text on consecutive lines) would confuse retrieval systems and must be removed. Pre-existing use of multiple # headings is outside this diff's scope but worth noting for a future pass.
  • Style Compliance: 8/10 - Button references are correctly bolded and match the new UI label (Cancel subscription). Navigation paths use the > convention properly. Terminology updates are consistent across both files.

Key Findings

Issues that must be fixed (introduced by this diff):

  1. Duplicate heading in Add-a-payment-card-and-view-your-subscription.md -- The section "How to request to cancel an annual subscription" now appears as both a # heading and a ## heading on consecutive lines. One must be removed. Per governance, this should be ## only (since the article already has a # title), but changing the # to ## would be a separate structural fix beyond this PR's scope. At minimum, remove the duplicate.

  2. Duplicate paragraph with typo in the same file -- Under "What to do if you can't update a subscription," the following two lines both appear in the diff:

    • If you're blocked from updating billing settings, requesting to canceling your subscription, or deleting a workspace... (grammatical error: "requesting to canceling")
    • If you're blocked from updating billing settings, requesting to cancel your subscription, or deleting a workspace... (corrected version)

    The first line with the typo must be removed entirely. Only the corrected version should remain.

Positive aspects:

  • Consistent terminology update across both files aligns with the current UI label.
  • The intro paragraph consolidation (merging two sentences into one) improves scannability.
  • Removal of the redundant "Note" about billing owner eligibility reduces duplication since that information already appears in the "Who can manage" section.

Recommendations

  1. [Required] Remove the duplicate ## How to request to cancel an annual subscription heading (or remove the # version and keep only ##).
  2. [Required] Remove the duplicate paragraph containing the "requesting to canceling" typo.
  3. [Optional, future improvement] The file uses multiple # headings for content sections (e.g., # How to stop billing for a paid workspace, # What to do if you can't update a subscription). Per HELP_AUTHORING_GUIDELINES.md Section 4, only one # heading (the article title) plus # FAQ is allowed. This pre-dates the current PR but should be addressed in a follow-up.

Files Reviewed

  • docs/articles/new-expensify/billing-and-subscriptions/Add-a-payment-card-and-view-your-subscription.md - Terminology updates are good; two copy-paste defects (duplicate heading, duplicate paragraph with typo) need fixing.
  • docs/articles/new-expensify/billing-and-subscriptions/Changing-Your-Workspace-Plan.md - Clean update, no issues found.

Review based on docs/HELP_AUTHORING_GUIDELINES.md, docs/HELPSITE_NAMING_CONVENTIONS.md, and docs/TEMPLATE.md.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/johncschuster in version: 9.3.74-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/Beamanator in version: 9.3.74-7 🚀

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

Emergency 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