Skip to content

Conversation

@stephanieelliott
Copy link
Contributor

See: https://github.com/Expensify/Expensify/issues/588714

Employee-facing guide for access issues, covers Magic code access troubleshooting

@github-actions
Copy link
Contributor

HelpDot Documentation Review

Overall Assessment

This PR introduces a comprehensive login troubleshooting guide that consolidates common access issues into a single, well-structured resource. The document addresses Magic Code delivery, 2FA lockouts, SSO errors, lost email access, and email blocking issues. The content is generally clear and user-focused, with a consistent formatting pattern and helpful contextual information.

Scores Summary

  • Readability: 8/10 - Clear language with good structure. Minor issues include some overly technical phrases and occasional passive voice. The document flows logically with good use of visual separators and formatting to guide readers.
  • AI Readiness: 7/10 - Strong metadata and descriptive headings. However, the title lacks the feature name context, and some sections use vague references like "the banner" without full context.
  • Style Compliance: 7/10 - Mostly consistent with Expensify documentation patterns. Issues include inconsistent capitalization in headings, mixing of "workspace" and "Workspace", and some terminology questions around "Magic Code" capitalization.

Key Findings

Strengths:

  • Excellent use of structured troubleshooting sections with "Common Cause," "What you can try," "What won't help," and "Who to contact"
  • Strong FAQ section addressing common questions
  • Good use of bold formatting for emphasis and visual hierarchy
  • Helpful cross-references to related documentation
  • User-centric language that addresses real pain points

Critical Issues:

  • Heading hierarchy inconsistency: Uses both single and double hash marks for main sections, which breaks navigation structure
  • Capitalization questions: "Magic Code" vs "magic code" inconsistent throughout
  • Vague references: Phrases like "the banner" and "the link" lack context for AI parsing
  • Missing breadcrumb context: Title doesn't include "Expensify" or product context
  • Terminology: "Workspace Owner" vs "workspace owner" needs consistency

Moderate Issues:

  • Some sections use technical jargon without definition (SAML, SMTP, MX records)
  • A few instances of passive voice could be more direct
  • Link text could be more descriptive for accessibility

Recommendations

Priority 1 - Must Fix:

  1. Standardize all main section headings to use double hash marks to maintain proper hierarchy
  2. Clarify title to include product context
  3. Replace vague references like "the banner" with full context

Priority 2 - Should Fix:
4. Standardize "Magic Code" capitalization (recommend title case as a proper feature name)
5. Ensure consistent capitalization for Workspace, Domain Admin, Identity Provider
6. Add brief definitions for technical terms on first use

Priority 3 - Nice to Have:
7. Convert passive constructions to active voice where possible
8. Make link text more descriptive
9. Consider adding a visual decision tree or flowchart for complex troubleshooting paths

Files Reviewed

  • docs/articles/new-expensify/settings/Login-Troubleshooting.md - New comprehensive troubleshooting guide (148 lines added)

This document provides valuable content that will help users resolve login issues independently. With the recommended heading and terminology fixes, it will be an excellent addition to the documentation set.

@github-actions github-actions bot changed the title Create Login-Troubleshooting.md [No QA] Create Login-Troubleshooting.md Jan 19, 2026
@OSBotify
Copy link
Contributor

OSBotify commented Jan 19, 2026

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

Updated articles:

@VictoriaExpensify VictoriaExpensify merged commit f7e7e47 into main Jan 21, 2026
12 of 13 checks passed
@VictoriaExpensify VictoriaExpensify deleted the stephanieelliott-patch-23 branch January 21, 2026 05:51
@melvin-bot melvin-bot bot added the Emergency label Jan 21, 2026
@melvin-bot
Copy link

melvin-bot bot commented Jan 21, 2026

@VictoriaExpensify 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/VictoriaExpensify in version: 9.3.6-0 🚀

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants