Skip to content

[No QA] [HelpDot] Add information for admins on freezing/unfreezing an Expensify Card for admins#80724

Open
MariaHCD wants to merge 5 commits intomainfrom
maria-freeze-card-admin
Open

[No QA] [HelpDot] Add information for admins on freezing/unfreezing an Expensify Card for admins#80724
MariaHCD wants to merge 5 commits intomainfrom
maria-freeze-card-admin

Conversation

@MariaHCD
Copy link
Copy Markdown
Contributor

@MariaHCD MariaHCD commented Jan 28, 2026

Explanation of Change

Fixed Issues

Part of https://github.com/Expensify/Expensify/issues/593794

Tests

  • Verify that no errors appear in the JS console

Offline tests

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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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

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

@MariaHCD MariaHCD self-assigned this Jan 28, 2026
@github-actions github-actions bot changed the title [HelpDot] Add information for admins on freezing/unfreezing an Expensify Card for admins [No QA] [HelpDot] Add information for admins on freezing/unfreezing an Expensify Card for admins Jan 28, 2026
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Jan 28, 2026

A preview of your ExpensifyHelp changes have been deployed to https://71e993a9.helpdot.pages.dev ⚡️

Updated articles:

CortneyOfstad
CortneyOfstad previously approved these changes Mar 11, 2026
@MariaHCD MariaHCD marked this pull request as ready for review April 10, 2026 08:48
@MariaHCD MariaHCD removed the request for review from stephanieelliott April 10, 2026 08:49
@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds a new section on freezing and unfreezing Expensify Cards to the existing "Set Up and Manage the Expensify Card" article. The content is clearly written and covers a useful workflow, but it has several structural violations against HelpDot governance rules that should be resolved before merging.

Scores Summary

  • Readability: 7/10 - The content is well-organized with a clear use-case list and post-action summary. The step instructions are concise and scannable. Minor friction from mixing "Click" and "Tap" verbs without platform context.
  • AI Readiness: 4/10 - The new section uses a # heading instead of ##, which breaks the single-#-per-article rule. There is no "How to" heading for this workflow, which is required for semantic retrieval. The ### subheading is not permitted under the heading hierarchy rules.
  • Style Compliance: 5/10 - Heading hierarchy violations (# and ### both prohibited in this context), heading is not task-based (missing action verb or question word), and inconsistent use of "Click" vs. "Tap" without platform-specific guidance.

Key Findings

  • Critical: Heading level violations. The added # Freeze or unfreeze Expensify Cards introduces a second # heading into the article. Per HELP_AUTHORING_GUIDELINES.md Section 4, only one # heading (the article title) is allowed, plus the optional # FAQ. This must be demoted to ##.
  • Critical: ### heading is forbidden. ### To freeze or unfreeze a card: uses a ### heading. Only # and ## are permitted. This subheading should either be converted to a ## task-based heading or removed entirely (folding the steps directly under the section heading).
  • Heading is not task-based. "Freeze or unfreeze Expensify Cards" is a noun/action phrase but does not follow the required pattern of starting with an action verb or question word. A compliant heading would be: ## How to freeze or unfreeze an Expensify Card.
  • Mixed interaction verbs. Step 2 uses "Click" while step 3 uses "Tap." Per HELPSITE_NAMING_CONVENTIONS.md, if web and mobile navigation differ, provide separate instructions. If they are the same, use consistent verbiage. Currently the mix may confuse readers about which platform is being described.
  • Positive: Clear, actionable content. The use-case bullet list explaining when freezing is helpful is well done. The post-action behavior section ("Once frozen") is precise and informative. The note about freeze/unfreeze actions posting to workspace chat is a useful detail.

Recommendations

  1. Demote # Freeze or unfreeze Expensify Cards to ## How to freeze or unfreeze an Expensify Card to fix heading hierarchy and make it task-based.
  2. Remove or convert the ### heading. Either fold the steps directly under the ## heading, or use a second ## heading if the content warrants its own section (e.g., ## How to freeze or unfreeze an Expensify Card).
  3. Use consistent interaction verbs. Either use "Click" throughout (if the flow is the same on web and mobile) or provide separate web/mobile instructions per the navigation conventions.
  4. Minor: Remove the trailing colon from the heading text (### To freeze or unfreeze a card:) -- headings should not end with colons.

Files Reviewed

  • docs/articles/new-expensify/expensify-card/Set-Up-and-Manage-the-Expensify-Card.md -- New section added with heading hierarchy and task-based heading issues that need correction.

3. Tap **Freeze card** or **Unfreeze card**.
4. Confirm the action in the popup modal.

Once frozen:
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/structure: The "Once frozen:" block is a standalone section of content but lacks a task-based ## heading. Per the authoring guidelines, all content sections below the title must use task-based ## headings. Consider wrapping this in a heading like ## What happens after you freeze an Expensify Card.

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

@MelvinBot given the review in #80724 (comment), update this PR to comply with our guidelines

Merge duplicate headings into a single task-based heading and convert
the second heading to a plain text intro line.

Co-authored-by: Maria D'Costa <[email protected]>
@MelvinBot
Copy link
Copy Markdown
Contributor

Updated the freeze/unfreeze section to address the review feedback:

  • Merged the two duplicate ## headings into a single task-based heading: ## How to freeze or unfreeze an Expensify Card
  • Converted the second heading into a plain text intro line (To freeze or unfreeze a card:)
  • Minor copy fix: removed stray hyphen in "workspace - without"

@MariaHCD MariaHCD requested a review from CortneyOfstad April 10, 2026 09:14
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.

4 participants