Skip to content

[No QA] Fix inaccuracies and expand on Update Update-Email-Address.md#87044

Merged
greg-schroeder merged 3 commits intomainfrom
stephanieelliott-patch-32
Apr 8, 2026
Merged

[No QA] Fix inaccuracies and expand on Update Update-Email-Address.md#87044
greg-schroeder merged 3 commits intomainfrom
stephanieelliott-patch-32

Conversation

@stephanieelliott
Copy link
Copy Markdown
Contributor

  • Fixed outdated UI steps
  • Fixed formatting for better AI retrieval
  • Added clarity that magic codes are only sent to the default contact method
  • Cross-linked to login troubleshooting article

@stephanieelliott stephanieelliott requested a review from a team April 3, 2026 03:56
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 3, 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 @greg-schroeder

@melvin-bot melvin-bot bot requested a review from greg-schroeder April 3, 2026 03:57
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 3, 2026

@greg-schroeder 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 April 3, 2026 03:57
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

HelpDot Documentation Review

Overall Assessment

This PR significantly improves the Update Email Address / Contact Methods article. The changes add missing YAML metadata (internalScope), fix the heading hierarchy to comply with governance rules, expand the FAQ section with useful questions, and correct the step-by-step flow to be more accurate. The article is well-structured and substantially better than the previous version.

Scores Summary

  • Readability: 9/10 - Clear, scannable, well-organized with logical sections. Steps are sequential and action-oriented. The FAQ section addresses real user questions effectively.
  • AI Readiness: 8/10 - Good task-based headings, comprehensive keywords, and proper internalScope metadata. All section headings start with valid action verbs or question words. Minor deduction for the cross-link using a full URL instead of a relative link, which affects retrieval optimization.
  • Style Compliance: 7/10 - Several deviations from naming conventions and navigation standards detailed below.

Key Findings

Positive aspects:

  • Adding internalScope to YAML frontmatter brings the article into metadata compliance.
  • Heading hierarchy is correct: one # title, ## content sections, and # FAQ -- all compliant.
  • Every ## heading starts with a valid action verb or question word (How, Why).
  • Includes a "How to..." heading using the feature name, satisfying AI retrieval rules.
  • FAQ section is well-crafted with questions that match real user search intent.
  • Removal of the emoji in the Note is an improvement (deterministic writing).

Issues that should be addressed:

  1. Full URL used instead of relative link (HELP_AUTHORING_GUIDELINES.md Section 7). The cross-link to the login troubleshooting guide uses https://help.expensify.com/articles/new-expensify/settings/Login-Troubleshooting -- governance requires relative links only. This should be changed to a relative path.

  2. Inconsistent action verbs in steps (HELPSITE_NAMING_CONVENTIONS.md). The steps mix "select" (steps 1, 2, 3, 7) and "Click" (step 6). The governance standard for the navigation line is "Click the navigation tabs..." but step 1 uses "In the navigation tabs... select." Choose one verb consistently, or match each to the exact UI interaction.

  3. Navigation phrasing deviates from governance standard. The governance standard is: "Click the navigation tabs (on the left on web, on the bottom on mobile)." The article uses: "In the navigation tabs (on the left on web, and at the bottom on mobile), select..." This should be rewritten to match the canonical phrasing.

  4. Link placed adjacent to introductory content before steps. The cross-link to the troubleshooting guide appears in the intro area, which is acceptable, but governance states "Do not place links inside numbered step instructions." This is currently compliant, but worth noting for future edits.

  5. "Contact methods" vs "Contact Method" casing. Step 2 references Contact methods (lowercase "m") and step 3 references New Contact Method (uppercase "M"). Ensure both match the exact UI casing per the deterministic writing rule.

  6. Last FAQ answer uses "please." The answer to "Why don't I see Set as default" includes "please verify it." HelpDot articles should be direct and action-oriented rather than using softening language.

Recommendations

  1. [Required] Replace the full URL cross-link with a relative link.
  2. [Required] Align navigation phrasing to the governance standard: "Click the navigation tabs (on the left on web, on the bottom on mobile)."
  3. [Recommended] Standardize action verbs across steps -- pick either "click" or "select" and use it consistently, matching actual UI behavior.
  4. [Recommended] Verify that Contact methods and New Contact Method match exact UI casing.
  5. [Minor] Remove "please" from the last FAQ answer to maintain direct, action-oriented tone.

Files Reviewed

  • docs/articles/new-expensify/settings/Update-Email-Address.md -- Substantially rewritten with expanded content, corrected heading structure, new FAQ section, and added internalScope metadata. Needs minor fixes for cross-link formatting and navigation phrasing consistency.

This review is based on the proposed diff only, scored against the governance files: HELPSITE_NAMING_CONVENTIONS.md, HELP_AUTHORING_GUIDELINES.md, and TEMPLATE.md.

@github-actions github-actions bot changed the title Fix inaccuracies and expand on Update Update-Email-Address.md [No QA] Fix inaccuracies and expand on Update Update-Email-Address.md Apr 3, 2026
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 3, 2026

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

Updated articles:

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c2481279ca

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

stephanieelliott and others added 2 commits April 2, 2026 21:41
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@greg-schroeder greg-schroeder merged commit c4c4beb into main Apr 8, 2026
15 checks passed
@greg-schroeder greg-schroeder deleted the stephanieelliott-patch-32 branch April 8, 2026 10:39
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 9, 2026

🚀 Deployed to staging by https://github.com/greg-schroeder in version: 9.3.55-0 🚀

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

Bundle Size Analysis (Sentry):

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.

3 participants