Skip to content

feat: Add Account app MFA instructions#492

Merged
elibosley merged 1 commit into
mainfrom
docs/account-app-mfa-instructions
May 28, 2026
Merged

feat: Add Account app MFA instructions#492
elibosley merged 1 commit into
mainfrom
docs/account-app-mfa-instructions

Conversation

@ctram
Copy link
Copy Markdown
Contributor

@ctram ctram commented May 27, 2026

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • Documentation
    • Added new multi-factor authentication (MFA) guide for Unraid accounts, including prerequisites, step-by-step setup instructions, disable procedures, and troubleshooting for common issues.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 27, 2026

📝 Walkthrough

Walkthrough

This PR introduces a new documentation page for multi-factor authentication (MFA) on Unraid accounts. The page covers prerequisites, step-by-step enable/disable flows, and common troubleshooting scenarios such as setup failures, rejected codes, and lost authenticator recovery.

Changes

Multi-Factor Authentication Documentation

Layer / File(s) Summary
MFA enable, disable, and troubleshooting guide
docs/unraid-account/multi-factor-authentication.mdx
New documentation page with prerequisites, step-by-step instructions for enabling MFA via QR code or setup URL, instructions for disabling MFA with a 6-digit code, and troubleshooting guidance for setup failures, rejected codes, and lost authenticator access.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🔐 A new guide hops onto the page,
With MFA wisdom for this digital age,
QR codes and codes to explore,
Security tips from one through four,
Authentication troubles now handled with care! 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The PR description includes the complete template with all 5 checklist items present. While items are unchecked (indicating incomplete submission), the required template structure and information are all included in the description.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding documentation for MFA instructions in the Account app, which matches the new file being introduced.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/account-app-mfa-instructions

Comment @coderabbitai help to get the list of available commands and usage tips.

@ctram ctram marked this pull request as draft May 27, 2026 18:31
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
unraid-docs 6c63daa Commit Preview URL

Branch Preview URL
May 27 2026, 06:31 PM

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/unraid-account/multi-factor-authentication.mdx (1)

40-42: 💤 Low value

Consider varying the sentence structure for better readability.

All three troubleshooting bullets begin with "If," creating a repetitive pattern. Rephrasing one improves flow.

📝 Suggested rewording
 - If setup fails, start again from the **MFA** tab in **Account Settings** and scan the new QR code.
-- If a code is rejected, wait for the next code in your authenticator app and try again.
+- When a code is rejected, wait for the next code in your authenticator app and try again.
 - If you no longer have access to your authenticator app, contact support for help recovering access to your account.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/unraid-account/multi-factor-authentication.mdx` around lines 40 - 42,
The three troubleshooting bullets in multi-factor-authentication.mdx are
repetitive because they all start with "If"; rephrase one or two bullets to vary
sentence structure for better flow — for example, change the first to "Should
setup fail, return to the MFA tab in Account Settings and scan the new QR code,"
or make the third active like "Contact support to recover access if you no
longer have your authenticator app" — update the three list items accordingly to
avoid starting each sentence with "If" while preserving the original meaning.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/unraid-account/multi-factor-authentication.mdx`:
- Around line 40-42: The three troubleshooting bullets in
multi-factor-authentication.mdx are repetitive because they all start with "If";
rephrase one or two bullets to vary sentence structure for better flow — for
example, change the first to "Should setup fail, return to the MFA tab in
Account Settings and scan the new QR code," or make the third active like
"Contact support to recover access if you no longer have your authenticator app"
— update the three list items accordingly to avoid starting each sentence with
"If" while preserving the original meaning.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: a0d3ac98-6149-4503-bc87-7d1a988fc2df

📥 Commits

Reviewing files that changed from the base of the PR and between 44b4691 and 6c63daa.

📒 Files selected for processing (1)
  • docs/unraid-account/multi-factor-authentication.mdx

@elibosley elibosley marked this pull request as ready for review May 27, 2026 19:16
@elibosley elibosley changed the title Add Account app MFA instructions feat: Add Account app MFA instructions May 27, 2026
Copy link
Copy Markdown
Member

@elibosley elibosley left a comment

Choose a reason for hiding this comment

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

Thanks Chris!

@elibosley elibosley merged commit c46d205 into main May 28, 2026
5 checks passed
@elibosley elibosley deleted the docs/account-app-mfa-instructions branch May 28, 2026 15:07
@coderabbitai coderabbitai Bot mentioned this pull request May 28, 2026
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