Skip to content

[No QA] Update Login-Troubleshooting.md - #98501

Open
brianlee-expensify wants to merge 1 commit into
mainfrom
brianlee-expensify-patch-3
Open

[No QA] Update Login-Troubleshooting.md#98501
brianlee-expensify wants to merge 1 commit into
mainfrom
brianlee-expensify-patch-3

Conversation

@brianlee-expensify

Copy link
Copy Markdown
Contributor

updated broken hyperlinks (coming from this slack thread)

Explanation of Change

Fixed Issues

$
PROPOSAL:

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

updated broken hyperlinks
- **Using a personal email?** If you’ve already tried the steps above, contact Concierge.

[See the full guide to fixing email delivery →](https://help.expensify.com/articles/expensify-classic/email/Troubleshoot-Email-Delivery-Issues)
[See the full guide to fixing email delivery →](https://help.expensify.com/articles/expensify-classic/settings/Email-Notifications)

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.

Link formatting violation (HELP_AUTHORING_GUIDELINES.md, Cross-Linking > Link Formatting): "Use relative links only. Do not use full URLs." Replace the full https://help.expensify.com/... URL with a relative link, e.g. /articles/expensify-classic/settings/Email-Notifications.

Also note an anchor text mismatch: the anchor reads "fixing email delivery" but now points to the Email-Notifications article. Update the anchor to describe the actual target (e.g. "Learn more about email notifications") so it reflects real search phrasing.

- **Reach out to your IT team** to confirm SSO settings and ask them to follow the relevant steps to [Troubleshoot SAML SSO Login](https://help.expensify.com/articles/new-expensify/domains/Troubleshoot-SAML-SSO-Login)

[More about SSO logins →](https://help.expensify.com/articles/new-expensify/domains/Managing-Single-Sign-On-(SSO)-in-Expensify)
[More about SSO logins →](https://help.expensify.com/articles/new-expensify/domains/Set-Up-SAML-SSO)

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.

Link formatting violation (HELP_AUTHORING_GUIDELINES.md, Cross-Linking > Link Formatting): "Use relative links only. Do not use full URLs." Replace the full https://help.expensify.com/... URL with a relative link, e.g. /articles/new-expensify/domains/Set-Up-SAML-SSO.

Also, the anchor "More about SSO logins" is vague and no longer matches the target (Set-Up-SAML-SSO). Anchor text should describe the task/feature clearly (e.g. "Learn how to set up SAML SSO").

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR ("[No QA] Update Login-Troubleshooting.md") fixes three broken hyperlinks in docs/articles/new-expensify/settings/Login-Troubleshooting.md. The changes are narrow and maintenance-oriented (link retargeting), with one link converted from a hyperlink to plain text. No structure, headings, metadata, or content flow were altered, so scores reflect only the modified link lines.

Scores Summary

  • Readability: 9/10 - The retargeted links and reworded sentence remain clear and scannable. Minor deduction because one useful reference was demoted to plain text (see below).
  • AI Readiness: 8/10 - No metadata or heading changes; retargeting to more specific destinations (Set-Up-SAML-SSO, Email-Notifications) is neutral-to-positive for retrieval. Not fully 10 because the links still use full external URLs rather than relative links.
  • Style Compliance: 7/10 - Anchor-text and link-formatting conventions are only partially met (see findings). No UI-terminology issues introduced.

Key Findings

  • Positive: The core goal of replacing broken links with valid destinations is achieved. The new targets (Set-Up-SAML-SSO, settings/Email-Notifications) appear more specific and appropriate than the dead links they replace.
  • Link formatting: All three links use full help.expensify.com URLs. HELP_AUTHORING_GUIDELINES.md Section 7 (Link Formatting) requires relative links and forbids full URLs. These were already full URLs pre-PR, so this is not a regression, but the PR was a chance to convert them.
  • Anchor text: "See the full guide to fixing email delivery" and "More about SSO logins" are borderline against the Anchor Text Rules, which favor descriptive "Learn how to [task]" / "Learn more about [Feature Name]" phrasing. Unchanged by this PR, so not penalized heavily.
  • Possible regression: The first change removed a descriptive hyperlink (allowlist Expensify emails) and replaced it with plain text ("add expensify.com to the allowlist"). If a valid allowlisting article exists, keeping a relative link would better serve users and cross-linking guidance. If the original link was the broken one being removed, plain text is acceptable.

Recommendations

  • Priority: Confirm the first change was intentional. If a working allowlisting article exists, restore it as a link (ideally relative) rather than plain text.
  • Optional cleanup: Convert the three full URLs to relative links (e.g. /articles/new-expensify/domains/Set-Up-SAML-SSO) to align with Section 7.
  • Optional: Tighten anchor text toward descriptive, task-based phrasing.

Files Reviewed

  • docs/articles/new-expensify/settings/Login-Troubleshooting.md - 3 link updates; changes are safe and on-target. Minor style/relative-link notes above; verify the plain-text conversion was intended.

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

@OSBotify

Copy link
Copy Markdown
Contributor

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

Updated articles:

@brianlee-expensify
brianlee-expensify requested a review from a team August 12, 2026 21:53
@melvin-bot

melvin-bot Bot commented Aug 12, 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 @bfitzexpensify

@melvin-bot
melvin-bot Bot requested review from bfitzexpensify and removed request for a team August 12, 2026 21:53
@melvin-bot

melvin-bot Bot commented Aug 12, 2026

Copy link
Copy Markdown

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

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.

2 participants