Skip to content

[Payment due @truph01] Docs updates for E/A#92749 add Save step to Pronouns instructions#93608

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

[Payment due @truph01] Docs updates for E/A#92749 add Save step to Pronouns instructions#93608
MelvinBot wants to merge 1 commit into
mainfrom
claude-docsPronounsSaveStep

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Summary

PR #92749 changed the Pronouns page (Settings → Profile → Pronouns) so that selecting a pronoun no longer auto-saves and closes the page. The user now selects a pronoun and must click Save to persist the change (WCAG 3.2.2 "On Input" fix).

This updates the Pronouns instructions in Account-Settings.md to add the Save step so the docs reflect the current behavior.

Changes

  • docs/articles/new-expensify/settings/Account-Settings.md — split the single "Click Pronouns and choose from the list of options" step into select-then-Save steps.

Not changed

  • Cash expense default (Workspace-Rules.md) — the help site only describes this setting in a feature bullet; it has no step-by-step "select to save" instructions, so no doc update is needed for the same behavior change.

@truph01, please review the files changed and confirm they reflect the current behavior. Then mark this PR Ready for review.

Co-authored-by: truph01 <truph01@users.noreply.github.com>
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Jun 15, 2026
@truph01

truph01 commented Jun 17, 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

@truph01

truph01 commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

@MelvinBot Mark this PR as ready for review

@MelvinBot MelvinBot marked this pull request as ready for review June 17, 2026 09:50
@melvin-bot melvin-bot Bot changed the title Docs updates for E/A#92749 add Save step to Pronouns instructions [Payment due @truph01] Docs updates for E/A#92749 add Save step to Pronouns instructions Jun 17, 2026
@melvin-bot

melvin-bot Bot commented Jun 17, 2026

Copy link
Copy Markdown

🎯 @truph01, thanks for reviewing and testing this PR! 🎉

A payment issue will be created for your review once this PR is deployed to production.
E/E issue linked to the PR - no internal issue.

If payment is not needed (e.g., regression PR review fix etc), react with 👎 to this comment to prevent the payment issue from being created.

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment
This PR makes a small, well-scoped update to the Pronouns instructions in Account-Settings.md. It splits the previous single 'Click Pronouns and choose from the list of options' step into three sequential steps (select Pronouns, choose from the list, click Save) to reflect the new UI behavior where selecting a pronoun no longer auto-saves. The change is accurate, minimal, and aligns with the WCAG 3.2.2 'On Input' fix from #92749.

Scores Summary

  • Readability: 9/10 - Steps are sequential, action-oriented, and each performs a single discrete action. The flow now matches the Status procedure directly above it, improving consistency and scannability.
  • AI Readiness: 8/10 - The diff aligns with retrieval and step-formatting standards. No metadata or heading changes were introduced (none were needed), so this is assessed on step quality alone, which is strong.
  • Style Compliance: 10/10 - Save is bold and in Sentence case per the Button Naming Standards. 'Click Pronouns' uses the exact UI label with correct bold formatting. No prohibited or vague navigation phrasing.

Key Findings

  • The added Save step correctly follows the Button Naming Standards (bold, Sentence case, no quotation marks).
  • New steps are properly sequential and each isolates a single action, matching the Step Formatting Standard.
  • The procedure now mirrors the adjacent Status flow, reinforcing consistency across the article.
  • Scope is appropriately limited: the PR correctly identifies that Workspace-Rules.md needs no change since it only describes the setting in a feature bullet, not as a step-by-step flow.

Recommendations

  • No blocking issues. The change is accurate and standards-compliant.
  • Optional (out of scope for this PR): the surrounding file uses several non-task-based headings (e.g., 'Profile Customization Options', 'Supported Languages', 'Pronouns') and multiple top-level headings, which do not meet the task-based, single-title rules in HELP_AUTHORING_GUIDELINES.md. These predate this PR and are not introduced here, so they are noted only for future cleanup.

Files Reviewed

  • Account-Settings.md (docs/articles/new-expensify/settings/) - Approved. Pronouns procedure updated correctly to add the Save step; fully compliant with naming and step-formatting conventions.

Note: Detailed line-by-line feedback has been provided as inline comments.

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.

2 participants